From 8f607f5bf2d2938750d01a51f50c7c132a70210f Mon Sep 17 00:00:00 2001 From: Adam Pocock Date: Fri, 29 Aug 2025 15:36:43 -0400 Subject: [PATCH] Javadoc fixes. --- .../org/tensorflow/op/StringsOps.java | 4 +- .../org/tensorflow/op/strings/Substr.java | 2 +- .../tensorflow/op/strings/UnicodeEncode.java | 2 +- .../tensorflow/op/annotation/Endpoint.java | 10 ++-- .../tensorflow/op/annotation/Operator.java | 58 ++++++++++++------- .../op/javadoc/CoreJavaDocNodeRenderer.java | 2 +- 6 files changed, 48 insertions(+), 30 deletions(-) diff --git a/tensorflow-core/tensorflow-core-api/src/gen/annotations/org/tensorflow/op/StringsOps.java b/tensorflow-core/tensorflow-core-api/src/gen/annotations/org/tensorflow/op/StringsOps.java index 56a82c2dbf6..b430b786294 100644 --- a/tensorflow-core/tensorflow-core-api/src/gen/annotations/org/tensorflow/op/StringsOps.java +++ b/tensorflow-core/tensorflow-core-api/src/gen/annotations/org/tensorflow/op/StringsOps.java @@ -350,7 +350,7 @@ public Strip strip(Operand input) { *

NOTE: {@code strings.Substr} supports broadcasting up to two dimensions. More about * broadcasting * here - *

+ *
*

Examples *

Using scalar {@code pos} and {@code len}: * 

@@ -670,7 +670,7 @@ public  UnicodeDecodeWithOffsets unicodeDecodeWithOffsets(
    *  Returns a vector of strings, where {@code output[i]} is constructed by encoding the
    *  Unicode codepoints in {@code input_values[input_splits[i]:input_splits[i+1]]}
    *  using {@code output_encoding}.
-   *  

+   *  

    *  
Example:
    *  
    *  input_values = [72, 101, 108, 108, 111, 87, 111, 114, 108, 100]
diff --git a/tensorflow-core/tensorflow-core-api/src/gen/java/org/tensorflow/op/strings/Substr.java b/tensorflow-core/tensorflow-core-api/src/gen/java/org/tensorflow/op/strings/Substr.java
index 868f2bc239b..d4eb10ae3b3 100644
--- a/tensorflow-core/tensorflow-core-api/src/gen/java/org/tensorflow/op/strings/Substr.java
+++ b/tensorflow-core/tensorflow-core-api/src/gen/java/org/tensorflow/op/strings/Substr.java
@@ -48,7 +48,7 @@
  * 
NOTE: {@code strings.Substr} supports broadcasting up to two dimensions. More about
  * broadcasting
  *  here 
- * 

+ * 

  * 
Examples
  * 
Using scalar {@code pos} and {@code len}:
  * 
diff --git a/tensorflow-core/tensorflow-core-api/src/gen/java/org/tensorflow/op/strings/UnicodeEncode.java b/tensorflow-core/tensorflow-core-api/src/gen/java/org/tensorflow/op/strings/UnicodeEncode.java
index 074ff7af61b..b6d686be8fc 100644
--- a/tensorflow-core/tensorflow-core-api/src/gen/java/org/tensorflow/op/strings/UnicodeEncode.java
+++ b/tensorflow-core/tensorflow-core-api/src/gen/java/org/tensorflow/op/strings/UnicodeEncode.java
@@ -40,7 +40,7 @@
  * Returns a vector of strings, where {@code output[i]} is constructed by encoding the
  * Unicode codepoints in {@code input_values[input_splits[i]:input_splits[i+1]]}
  * using {@code output_encoding}.
- * 

+ * 

  * 
Example:
  * 
  * input_values = [72, 101, 108, 108, 111, 87, 111, 114, 108, 100]
diff --git a/tensorflow-core/tensorflow-core-api/src/main/java/org/tensorflow/op/annotation/Endpoint.java b/tensorflow-core/tensorflow-core-api/src/main/java/org/tensorflow/op/annotation/Endpoint.java
index 2d64e50d747..ac2684e678e 100644
--- a/tensorflow-core/tensorflow-core-api/src/main/java/org/tensorflow/op/annotation/Endpoint.java
+++ b/tensorflow-core/tensorflow-core-api/src/main/java/org/tensorflow/op/annotation/Endpoint.java
@@ -28,15 +28,17 @@
  * 
It is mandatory for the annotated method to be public, static and to take as its first
  * parameter an instance of {@link org.tensorflow.op.Scope}. For example:
  *
- * 
{@code
- * @Operator
+ * 
+ * {@code
+ * {@literal @}Operator
  * public class MyOp implements Op {
- *     @Endpoint
+ *     {@literal @}Endpoint
  *     public static MyOp create(Scope scope, Operand input) {
  *       ...
  *     }
  * }
- * }

+ * }
+ * 

  *
  * In addition, two endpoints of the same class cannot have the same signature, or the annotation
  * processor will fail to generate the {@code Ops} classes.
diff --git a/tensorflow-core/tensorflow-core-api/src/main/java/org/tensorflow/op/annotation/Operator.java b/tensorflow-core/tensorflow-core-api/src/main/java/org/tensorflow/op/annotation/Operator.java
index 748fab26230..7f0212f8714 100644
--- a/tensorflow-core/tensorflow-core-api/src/main/java/org/tensorflow/op/annotation/Operator.java
+++ b/tensorflow-core/tensorflow-core-api/src/main/java/org/tensorflow/op/annotation/Operator.java
@@ -31,19 +31,22 @@
  * {@link org.tensorflow.op.Scope} as its first argument. The processor then adds a convenience
  * method in the {@code Ops} class. For example:
  *
- * 
{@code
- * @Operator
+ * 
+ * {@code
+ * {@literal @}Operator
  * public final class MyOp implements Op {
- *   @Endpoint
+ *   {@literal @}Endpoint
  *   public static MyOp create(Scope scope, Operand operand) {
  *     ...
  *   }
  * }
- * }

+ * }
+ * 

  *
  * 
results in a method in the {@code Ops} class
  *
- * 
{@code
+ * 
+ * {@code
  * import org.tensorflow.op.Ops;
  * ...
  * Ops ops = Ops.create(graph);
@@ -51,7 +54,8 @@
  * ops.myOp(operand);
  * // and has exactly the same effect as calling
  * // MyOp.create(ops.getScope(), operand);
- * }

+ * }
+ * 

  */
 @Documented
 @Target(ElementType.TYPE)
@@ -64,36 +68,44 @@
    * Ops} class. An annotated operator may optionally choose to place the method within a group. For
    * example:
    *
-   * 
{@code
-   * @Operator(group="math")
+   * 
+   * {@code
+   * {@literal @}Operator(group="math")
    * public final class Add extends RawOp implements Operand {
    *   ...
    * }
-   * }

+   * }
+   * 

    *
    * 
results in the {@code add} method placed within a {@code math} group within the {@code Ops}
    * class.
    *
-   * 
{@code
+   * 
+   * {@code
    * ops.math.add(...);
-   * }

+   * }
+   * 

    *
    * 
The operator can also be classified into subgroups of another group, following a semantic
    * similar to Java packages. For example:
    *
-   * 
{@code
-   * @Operator(group="data.experimental")
+   * 
+   * {@code
+   * {@literal @}Operator(group="data.experimental")
    * public final class MyDataset extends RawOp implements Operand {
    *   ...
    * }
-   * }

+   * }
+   * 

    *
    * 
results in the {@code add} method placed within a {@code experimental} group within the
    * {@code DataOps} group class.
    *
-   * 
{@code
+   * 
+   * {@code
    * ops.data.experimental.myDataset(...);
-   * }

+   * }
+   * 

    *
    * 
The group name must be a valid Java package
@@ -107,20 +119,24 @@
    * 
By default, a processor derives the method name in the {@code Ops} class from the class name
    * of the operator. This attribute allow you to provide a different name instead. For example:
    *
-   * 
{@code
-   * @Operator(name="myOperation")
+   * 
+   * {@code
+   * {@literal @}Operator(name="myOperation")
    * public final class MyRealOperation implements Operand {
    *   public static MyRealOperation create(...)
    * }
-   * }

+   * }
+   * 

    *
    * 
results in this method added to the {@code Ops} class
    *
-   * 
{@code
+   * 
+   * {@code
    * ops.myOperation(...);
    * // and is the same as calling
    * // MyRealOperation.create(...)
-   * }

+   * }
+   * 

    *
    * 
The name must be a valid Java
diff --git a/tensorflow-core/tensorflow-core-generator/src/main/java/org/tensorflow/generator/op/javadoc/CoreJavaDocNodeRenderer.java b/tensorflow-core/tensorflow-core-generator/src/main/java/org/tensorflow/generator/op/javadoc/CoreJavaDocNodeRenderer.java
index 37c26c2a292..6464990eece 100644
--- a/tensorflow-core/tensorflow-core-generator/src/main/java/org/tensorflow/generator/op/javadoc/CoreJavaDocNodeRenderer.java
+++ b/tensorflow-core/tensorflow-core-generator/src/main/java/org/tensorflow/generator/op/javadoc/CoreJavaDocNodeRenderer.java
@@ -281,7 +281,7 @@ public void visit(HtmlBlock htmlBlock) {
   @Override
   public void visit(ThematicBreak thematicBreak) {
     writer.line();
-    writer.tag("hr", getAttrs(thematicBreak, "hr"), true);
+    writer.tag("hr", getAttrs(thematicBreak, "hr"), false);
     writer.line();
   }