[
https://issues.apache.org/jira/browse/BEAM-3351?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=16332712#comment-16332712
]
ASF GitHub Bot commented on BEAM-3351:
--
kennknowles closed pull request #4263: [BEAM-3351] Fix Javadoc formatting issues
URL: https://github.com/apache/beam/pull/4263
This is a PR merged from a forked repository.
As GitHub hides the original diff on merge, it is displayed below for
the sake of provenance:
As this is a foreign pull request (from a fork), the diff is supplied
below (as it won't show otherwise due to GitHub magic):
diff --git a/sdks/java/core/src/main/java/org/apache/beam/sdk/coders/Coder.java
b/sdks/java/core/src/main/java/org/apache/beam/sdk/coders/Coder.java
index 78a4a027663..eb63bde2f69 100644
--- a/sdks/java/core/src/main/java/org/apache/beam/sdk/coders/Coder.java
+++ b/sdks/java/core/src/main/java/org/apache/beam/sdk/coders/Coder.java
@@ -59,9 +59,9 @@
/**
* The context in which encoding or decoding is being done.
*
- * @deprecated to implement a coder, do not use any `Context`. Just
implement only those abstract
- * methods which do not accept a `Context` and leave the default
implementations for methods
- * accepting a `Context`.
+ * @deprecated To implement a coder, do not use any {@link Context}. Just
implement only those
+ * abstract methods which do not accept a {@link Context} and leave the
default implementations
+ * for methods accepting a {@link Context}.
*/
@Deprecated
@Experimental(Kind.CODER_CONTEXT)
@@ -241,7 +241,7 @@ public boolean consistentWithEquals() {
* the argument.
*
* For any two values {@code x} and {@code y} of type {@code T}, if their
encoded bytes are the
- * same, then it must be the case that {@code
structuralValue(x).equals(@code structuralValue(y)}.
+ * same, then it must be the case that {@code
structuralValue(x).equals(structuralValue(y))}.
*
* Most notably:
*
diff --git
a/sdks/java/core/src/main/java/org/apache/beam/sdk/transforms/windowing/Trigger.java
b/sdks/java/core/src/main/java/org/apache/beam/sdk/transforms/windowing/Trigger.java
index 6985565bd2e..120d0c8e36e 100644
---
a/sdks/java/core/src/main/java/org/apache/beam/sdk/transforms/windowing/Trigger.java
+++
b/sdks/java/core/src/main/java/org/apache/beam/sdk/transforms/windowing/Trigger.java
@@ -30,7 +30,7 @@
import org.joda.time.Instant;
/**
- * {@link Trigger Triggers} control when the elements for a specific key and
window are output. As
+ * Triggers control when the elements for a specific key and window are
output. As
* elements arrive, they are put into one or more windows by a {@link Window}
transform and its
* associated {@link WindowFn}, and then passed to the associated {@link
Trigger} to determine if
* the {@link BoundedWindow Window's} contents should be output.
@@ -44,7 +44,7 @@
* output. When the root trigger finishes (indicating it will never fire
again), the window is
* closed and any new elements assigned to that window are discarded.
*
- * Several predefined {@link Trigger Triggers} are provided:
+ * Several predefined triggers are provided:
*
*
* {@link AfterWatermark} for firing when the watermark passes a
timestamp determined from
@@ -55,7 +55,7 @@
* number of elements that have been assigned to the current pane.
*
*
- * In addition, {@code Trigger}s can be combined in a variety of ways:
+ * In addition, triggers can be combined in a variety of ways:
*
*
* {@link Repeatedly#forever} to create a trigger that executes forever.
Any time its argument
@@ -221,7 +221,7 @@ public OrFinallyTrigger orFinally(OnceTrigger until) {
/**
* For internal use only; no backwards-compatibility
guarantees.
*
- * {@link Trigger Triggers} that are guaranteed to fire at most once should
extend {@link
+ * Triggers that are guaranteed to fire at most once should extend {@link
* OnceTrigger} rather than the general {@link Trigger} class to indicate
that behavior.
*/
@Internal
This is an automated message from the Apache Git Service.
To respond to the message, please log on GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
us...@infra.apache.org
> Coder and Trigger Javadoc pages have formatting issues
> --
>
> Key: BEAM-3351
> URL: https://issues.apache.org/jira/browse/BEAM-3351
> Project: Beam
> Issue Type: Bug
> Components: website
>Reporter: Melissa Pashniak
>Assignee: Melissa Pashniak
>Priority: Trivial
>
> for example, Coder:
> multiple uses of `Context` (not code formatted)
> structuralValue(x).equals(@code structuralValue(y) (extra @code)
