Skip to content

Commit 8f607f5

Browse files
committed
Javadoc fixes.
1 parent e9c854f commit 8f607f5

File tree

6 files changed

+48
-30
lines changed

6 files changed

+48
-30
lines changed

tensorflow-core/tensorflow-core-api/src/gen/annotations/org/tensorflow/op/StringsOps.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -350,7 +350,7 @@ public Strip strip(Operand<TString> input) {
350350
* <p><em>NOTE</em>: {@code strings.Substr} supports broadcasting up to two dimensions. More about
351351
* broadcasting
352352
* <a href="http://docs.scipy.org/doc/numpy/user/basics.broadcasting.html">here</a>
353-
* <hr />
353+
* <hr>
354354
* <p>Examples
355355
* <p>Using scalar {@code pos} and {@code len}:
356356
* <pre>
@@ -670,7 +670,7 @@ public <T extends TNumber> UnicodeDecodeWithOffsets<T> unicodeDecodeWithOffsets(
670670
* Returns a vector of strings, where {@code output[i]} is constructed by encoding the
671671
* Unicode codepoints in {@code input_values[input_splits[i]:input_splits[i+1]]}
672672
* using {@code output_encoding}.
673-
* <hr />
673+
* <hr>
674674
* <p>Example:
675675
* <pre>
676676
* input_values = [72, 101, 108, 108, 111, 87, 111, 114, 108, 100]

tensorflow-core/tensorflow-core-api/src/gen/java/org/tensorflow/op/strings/Substr.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@
4848
* <p><em>NOTE</em>: {@code strings.Substr} supports broadcasting up to two dimensions. More about
4949
* broadcasting
5050
* <a href="http://docs.scipy.org/doc/numpy/user/basics.broadcasting.html">here</a>
51-
* <hr />
51+
* <hr>
5252
* <p>Examples
5353
* <p>Using scalar {@code pos} and {@code len}:
5454
* <pre>

tensorflow-core/tensorflow-core-api/src/gen/java/org/tensorflow/op/strings/UnicodeEncode.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@
4040
* Returns a vector of strings, where {@code output[i]} is constructed by encoding the
4141
* Unicode codepoints in {@code input_values[input_splits[i]:input_splits[i+1]]}
4242
* using {@code output_encoding}.
43-
* <hr />
43+
* <hr>
4444
* <p>Example:
4545
* <pre>
4646
* input_values = [72, 101, 108, 108, 111, 87, 111, 114, 108, 100]

tensorflow-core/tensorflow-core-api/src/main/java/org/tensorflow/op/annotation/Endpoint.java

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -28,15 +28,17 @@
2828
* <p>It is mandatory for the annotated method to be public, static and to take as its first
2929
* parameter an instance of {@link org.tensorflow.op.Scope}. For example:
3030
*
31-
* <pre>{@code
32-
* @Operator
31+
* <pre>
32+
* {@code
33+
* {@literal @}Operator
3334
* public class MyOp implements Op {
34-
* @Endpoint
35+
* {@literal @}Endpoint
3536
* public static MyOp create(Scope scope, Operand<?> input) {
3637
* ...
3738
* }
3839
* }
39-
* }</pre>
40+
* }
41+
* </pre>
4042
*
4143
* In addition, two endpoints of the same class cannot have the same signature, or the annotation
4244
* processor will fail to generate the {@code Ops} classes.

tensorflow-core/tensorflow-core-api/src/main/java/org/tensorflow/op/annotation/Operator.java

Lines changed: 37 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -31,27 +31,31 @@
3131
* {@link org.tensorflow.op.Scope} as its first argument. The processor then adds a convenience
3232
* method in the {@code Ops} class. For example:
3333
*
34-
* <pre>{@code
35-
* @Operator
34+
* <pre>
35+
* {@code
36+
* {@literal @}Operator
3637
* public final class MyOp implements Op {
37-
* @Endpoint
38+
* {@literal @}Endpoint
3839
* public static MyOp create(Scope scope, Operand<?> operand) {
3940
* ...
4041
* }
4142
* }
42-
* }</pre>
43+
* }
44+
* </pre>
4345
*
4446
* <p>results in a method in the {@code Ops} class
4547
*
46-
* <pre>{@code
48+
* <pre>
49+
* {@code
4750
* import org.tensorflow.op.Ops;
4851
* ...
4952
* Ops ops = Ops.create(graph);
5053
* ...
5154
* ops.myOp(operand);
5255
* // and has exactly the same effect as calling
5356
* // MyOp.create(ops.getScope(), operand);
54-
* }</pre>
57+
* }
58+
* </pre>
5559
*/
5660
@Documented
5761
@Target(ElementType.TYPE)
@@ -64,36 +68,44 @@
6468
* Ops} class. An annotated operator may optionally choose to place the method within a group. For
6569
* example:
6670
*
67-
* <pre>{@code
68-
* @Operator(group="math")
71+
* <pre>
72+
* {@code
73+
* {@literal @}Operator(group="math")
6974
* public final class Add extends RawOp implements Operand {
7075
* ...
7176
* }
72-
* }</pre>
77+
* }
78+
* </pre>
7379
*
7480
* <p>results in the {@code add} method placed within a {@code math} group within the {@code Ops}
7581
* class.
7682
*
77-
* <pre>{@code
83+
* <pre>
84+
* {@code
7885
* ops.math.add(...);
79-
* }</pre>
86+
* }
87+
* </pre>
8088
*
8189
* <p>The operator can also be classified into subgroups of another group, following a semantic
8290
* similar to Java packages. For example:
8391
*
84-
* <pre>{@code
85-
* @Operator(group="data.experimental")
92+
* <pre>
93+
* {@code
94+
* {@literal @}Operator(group="data.experimental")
8695
* public final class MyDataset extends RawOp implements Operand {
8796
* ...
8897
* }
89-
* }</pre>
98+
* }
99+
* </pre>
90100
*
91101
* <p>results in the {@code add} method placed within a {@code experimental} group within the
92102
* {@code DataOps} group class.
93103
*
94-
* <pre>{@code
104+
* <pre>
105+
* {@code
95106
* ops.data.experimental.myDataset(...);
96-
* }</pre>
107+
* }
108+
* </pre>
97109
*
98110
* <p>The group name must be a <a
99111
* href="https://docs.oracle.com/javase/tutorial/java/package/namingpkgs.html">valid Java package
@@ -107,20 +119,24 @@
107119
* <p>By default, a processor derives the method name in the {@code Ops} class from the class name
108120
* of the operator. This attribute allow you to provide a different name instead. For example:
109121
*
110-
* <pre>{@code
111-
* @Operator(name="myOperation")
122+
* <pre>
123+
* {@code
124+
* {@literal @}Operator(name="myOperation")
112125
* public final class MyRealOperation implements Operand {
113126
* public static MyRealOperation create(...)
114127
* }
115-
* }</pre>
128+
* }
129+
* </pre>
116130
*
117131
* <p>results in this method added to the {@code Ops} class
118132
*
119-
* <pre>{@code
133+
* <pre>
134+
* {@code
120135
* ops.myOperation(...);
121136
* // and is the same as calling
122137
* // MyRealOperation.create(...)
123-
* }</pre>
138+
* }
139+
* </pre>
124140
*
125141
* <p>The name must be a <a
126142
* href="https://docs.oracle.com/javase/specs/jls/se7/html/jls-3.html#jls-3.8">valid Java

tensorflow-core/tensorflow-core-generator/src/main/java/org/tensorflow/generator/op/javadoc/CoreJavaDocNodeRenderer.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -281,7 +281,7 @@ public void visit(HtmlBlock htmlBlock) {
281281
@Override
282282
public void visit(ThematicBreak thematicBreak) {
283283
writer.line();
284-
writer.tag("hr", getAttrs(thematicBreak, "hr"), true);
284+
writer.tag("hr", getAttrs(thematicBreak, "hr"), false);
285285
writer.line();
286286
}
287287

0 commit comments

Comments
 (0)