Fix javadoc

Co-authored-by: Adam Pocock <[email protected]>

Author: karllessard

pom.xml

@@ -26,7 +26,7 @@
 
   <scm>
     <url>https://github.com/tensorflow/java.git</url>
-    <connection>[email protected]:tensorflow/java.git</connection>
+    <connection>scm:[email protected]:tensorflow/java.git</connection>
     <developerConnection>scm:git:https://github.com/tensorflow/java.git</developerConnection>
   </scm>
 

tensorflow-core/tensorflow-core-api/pom.xml

@@ -230,6 +230,12 @@
               <goal>jar</goal>
             </goals>
             <configuration>
+              <additionalJOptions>
+                <additionalJOption>-Xmaxerrs</additionalJOption>
+                <additionalJOption>65536</additionalJOption>
+                <additionalJOption>-Xmaxwarns</additionalJOption>
+                <additionalJOption>65536</additionalJOption>
+              </additionalJOptions>
               <failOnError>false</failOnError>
               <minmemory>256m</minmemory>
               <maxmemory>2048m</maxmemory>

tensorflow-core/tensorflow-core-api/src/api/api_def_SegmentSumV2.pbtxt

@@ -4,4 +4,18 @@ op {
   endpoint {
     name: "math.SegmentSum"
   }
+  description: <<END
+Read
+[the section on segmentation](https://tensorflow.org/api_docs/python/tf/math#Segmentation)
+for an explanation of segments.
+
+Computes a tensor such that
+\\(output_i = \sum_j data_j\\) where sum is over `j` such
+that `segment_ids[j] == i`.
+
+If the sum is empty for a given segment ID `i`, `output[i] = 0`.
+
+Note that this op is currently only supported with jit_compile=True.
+
+END
 }

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

@@ -29,7 +29,7 @@
 /**
  * An API for building {@code audio} operations as {@link Op Op}s
  *
- * @see {@link Ops}
+ * @see Ops
  */
 public final class AudioOps {
   private final Scope scope;

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

@@ -29,7 +29,7 @@
 /**
  * An API for building {@code bitwise} operations as {@link Op Op}s
  *
- * @see {@link Ops}
+ * @see Ops
  */
 public final class BitwiseOps {
   private final Scope scope;

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

@@ -26,7 +26,7 @@
 /**
  * An API for building {@code cluster} operations as {@link Op Op}s
  *
- * @see {@link Ops}
+ * @see Ops
  */
 public final class ClusterOps {
   private final Scope scope;

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

@@ -34,7 +34,7 @@
 /**
  * An API for building {@code collective} operations as {@link Op Op}s
  *
- * @see {@link Ops}
+ * @see Ops
  */
 public final class CollectiveOps {
   private final Scope scope;

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

@@ -66,7 +66,7 @@
 /**
  * An API for building {@code data.experimental} operations as {@link Op Op}s
  *
- * @see {@link Ops}
+ * @see Ops
  */
 public final class DataExperimentalOps {
   private final Scope scope;

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

@@ -155,7 +155,7 @@
 /**
  * An API for building {@code data} operations as {@link Op Op}s
  *
- * @see {@link Ops}
+ * @see Ops
  */
 public final class DataOps {
   public final DataExperimentalOps experimental;

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

@@ -24,7 +24,7 @@
 /**
  * An API for building {@code debugging} operations as {@link Op Op}s
  *
- * @see {@link Ops}
+ * @see Ops
  */
 public final class DebuggingOps {
   private final Scope scope;

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

@@ -27,7 +27,7 @@
 /**
  * An API for building {@code distribute} operations as {@link Op Op}s
  *
- * @see {@link Ops}
+ * @see Ops
  */
 public final class DistributeOps {
   private final Scope scope;

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

@@ -28,7 +28,7 @@
 /**
  * An API for building {@code dtypes} operations as {@link Op Op}s
  *
- * @see {@link Ops}
+ * @see Ops
  */
 public final class DtypesOps {
   private final Scope scope;

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

@@ -71,7 +71,7 @@
 /**
  * An API for building {@code image} operations as {@link Op Op}s
  *
- * @see {@link Ops}
+ * @see Ops
  */
 public final class ImageOps {
   private final Scope scope;

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

@@ -78,7 +78,7 @@
 /**
  * An API for building {@code io} operations as {@link Op Op}s
  *
- * @see {@link Ops}
+ * @see Ops
  */
 public final class IoOps {
   private final Scope scope;

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

@@ -80,7 +80,7 @@
 /**
  * An API for building {@code linalg} operations as {@link Op Op}s
  *
- * @see {@link Ops}
+ * @see Ops
  */
 public final class LinalgOps {
   public final LinalgSparseOps sparse;

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

@@ -42,7 +42,7 @@
 /**
  * An API for building {@code linalg.sparse} operations as {@link Op Op}s
  *
- * @see {@link Ops}
+ * @see Ops
  */
 public final class LinalgSparseOps {
   private final Scope scope;

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

@@ -147,7 +147,7 @@
 /**
  * An API for building {@code math} operations as {@link Op Op}s
  *
- * @see {@link Ops}
+ * @see Ops
  */
 public final class MathOps {
   public final MathSpecialOps special;

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

@@ -36,7 +36,7 @@
 /**
  * An API for building {@code math.special} operations as {@link Op Op}s
  *
- * @see {@link Ops}
+ * @see Ops
  */
 public final class MathSpecialOps {
   private final Scope scope;

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

@@ -138,7 +138,7 @@
 /**
  * An API for building {@code nn} operations as {@link Op Op}s
  *
- * @see {@link Ops}
+ * @see Ops
  */
 public final class NnOps {
   private final Scope scope;

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

@@ -9159,7 +9159,7 @@ public <T extends TType> ZerosLike<T> zerosLike(Operand<T> x) {
   /**
    * Returns an API that builds operations with the provided name prefix.
    *
-   * @see {@link Scope#withSubScope(String)}
+   * @see Scope#withSubScope(String)
    */
   public Ops withSubScope(String childScopeName) {
     return new Ops(scope.withSubScope(childScopeName));
@@ -9181,7 +9181,7 @@ public Ops withInitScope() {
   /**
    * Returns an API that uses the provided name for an op.
    *
-   * @see {@link Scope#withName(String)}
+   * @see Scope#withName(String)
    */
   public Ops withName(String opName) {
     return new Ops(scope.withName(opName));
@@ -9190,7 +9190,7 @@ public Ops withName(String opName) {
   /**
    * Returns an API that places the created operations on the device(s) matching the provided spec.
    *
-   * @see {@link Scope#withDevice(DeviceSpec)}
+   * @see Scope#withDevice(DeviceSpec)
    */
   public Ops withDevice(DeviceSpec deviceSpec) {
     return new Ops(scope.withDevice(deviceSpec));
@@ -9199,7 +9199,7 @@ public Ops withDevice(DeviceSpec deviceSpec) {
   /**
    * Returns an API that adds operations to the graph with the provided control dependencies.
    *
-   * @see {@link Scope#withControlDependencies(Iterable<Op<?>>)}
+   * @see Scope#withControlDependencies(Iterable)
    */
   public Ops withControlDependencies(Iterable<Op> controls) {
     return new Ops(scope.withControlDependencies(controls));
@@ -9208,7 +9208,7 @@ public Ops withControlDependencies(Iterable<Op> controls) {
   /**
    * Returns an API that adds operations to the graph with the provided control dependencies.
    *
-   * @see {@link Scope#withControlDependencies(Iterable<Op<?>>)}
+   * @see Scope#withControlDependencies(Iterable)
    */
   public Ops withControlDependencies(Op... controls) {
     return withControlDependencies(Arrays.asList(controls));
@@ -9217,7 +9217,7 @@ public Ops withControlDependencies(Op... controls) {
   /**
    * Returns an API that adds operations to the graph with the provided control dependencies.
    *
-   * @see {@link Scope#withControlDependencyOps(Iterable<Operation>)}
+   * @see Scope#withControlDependencyOps(Iterable)
    */
   public Ops withControlDependencyOps(Iterable<Operation> controls) {
     return new Ops(scope.withControlDependencyOps(controls));
@@ -9226,7 +9226,7 @@ public Ops withControlDependencyOps(Iterable<Operation> controls) {
   /**
    * Returns an API that adds operations to the graph with the provided control dependencies.
    *
-   * @see {@link Scope#withControlDependencyOps(Iterable<Operation>)}
+   * @see Scope#withControlDependencyOps(Iterable)
    */
   public Ops withControlDependencyOps(Operation... controls) {
     return withControlDependencyOps(Arrays.asList(controls));

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

@@ -49,7 +49,7 @@
 /**
  * An API for building {@code quantization} operations as {@link Op Op}s
  *
- * @see {@link Ops}
+ * @see Ops
  */
 public final class QuantizationOps {
   private final Scope scope;

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

@@ -39,7 +39,7 @@
 /**
  * An API for building {@code ragged} operations as {@link Op Op}s
  *
- * @see {@link Ops}
+ * @see Ops
  */
 public final class RaggedOps {
   private final Scope scope;

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

@@ -25,7 +25,7 @@
 /**
  * An API for building {@code random.experimental} operations as {@link Op Op}s
  *
- * @see {@link Ops}
+ * @see Ops
  */
 public final class RandomExperimentalOps {
   private final Scope scope;

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

@@ -75,7 +75,7 @@
 /**
  * An API for building {@code random} operations as {@link Op Op}s
  *
- * @see {@link Ops}
+ * @see Ops
  */
 public final class RandomOps {
   public final RandomExperimentalOps experimental;

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

@@ -28,7 +28,7 @@
 /**
  * An API for building {@code shape} operations as {@link Op Op}s
  *
- * @see {@link Ops}
+ * @see Ops
  */
 public final class ShapeOps {
   private final Scope scope;

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

@@ -48,7 +48,7 @@
 /**
  * An API for building {@code signal} operations as {@link Op Op}s
  *
- * @see {@link Ops}
+ * @see Ops
  */
 public final class SignalOps {
   private final Scope scope;

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

@@ -77,7 +77,7 @@
 /**
  * An API for building {@code sparse} operations as {@link Op Op}s
  *
- * @see {@link Ops}
+ * @see Ops
  */
 public final class SparseOps {
   private final Scope scope;

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

@@ -52,7 +52,7 @@
 /**
  * An API for building {@code strings} operations as {@link Op Op}s
  *
- * @see {@link Ops}
+ * @see Ops
  */
 public final class StringsOps {
   private final Scope scope;

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

@@ -49,7 +49,7 @@
 /**
  * An API for building {@code summary} operations as {@link Op Op}s
  *
- * @see {@link Ops}
+ * @see Ops
  */
 public final class SummaryOps {
   private final Scope scope;

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

@@ -130,7 +130,7 @@
 /**
  * An API for building {@code tpu} operations as {@link Op Op}s
  *
- * @see {@link Ops}
+ * @see Ops
  */
 public final class TpuOps {
   private final Scope scope;

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

@@ -108,7 +108,7 @@
 /**
  * An API for building {@code train} operations as {@link Op Op}s
  *
- * @see {@link Ops}
+ * @see Ops
  */
 public final class TrainOps {
   private final Scope scope;

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

@@ -50,7 +50,7 @@
 /**
  * An API for building {@code xla} operations as {@link Op Op}s
  *
- * @see {@link Ops}
+ * @see Ops
  */
 public final class XlaOps {
   private final Scope scope;

tensorflow-core/tensorflow-core-api/src/gen/java/org/tensorflow/op/core/ApproxTopK.java

@@ -291,17 +291,17 @@ public static class Inputs<T extends TNumber> extends RawOpInputs<ApproxTopK<T>>
 
     /**
      * When set to a positive value, it overrides the size determined by
-     * `input[reduction_dim]` for evaluating the recall. This option is useful when
-     * the given `input` is only a subset of the overall computation in SPMD or
+     * {@code input[reduction_dim]} for evaluating the recall. This option is useful when
+     * the given {@code input} is only a subset of the overall computation in SPMD or
      * distributed pipelines, where the true input size cannot be deferred by the
-     * `input` shape.
+     * {@code input} shape.
      */
     public final long reductionInputSizeOverride;
 
     /**
      * When true, aggregates approximate results to top-k. When false, returns the
      * approximate results. The number of the approximate results is implementation
-     * defined and is greater equals to the specified `k`.
+     * defined and is greater equals to the specified {@code k}.
      */
     public final boolean aggregateToTopk;
 

tensorflow-core/tensorflow-core-api/src/gen/java/org/tensorflow/op/core/BatchFunction.java

@@ -588,7 +588,7 @@ public static class Inputs extends RawOpInputs<BatchFunction> {
 
     /**
      * input with a large size (i.e., larger than the largest value of
-     * `allowed_batch_sizes`) will be splitted into multiple batches with batch size.
+     * {@code allowed_batch_sizes}) will be splitted into multiple batches with batch size.
      */
     public final boolean enableLargeBatchSplitting;
 

tensorflow-core/tensorflow-core-api/src/gen/java/org/tensorflow/op/core/CompositeTensorVariantToComponents.java

@@ -113,7 +113,7 @@ public static class Inputs extends RawOpInputs<CompositeTensorVariantToComponent
 
     /**
      * String serialization for the TypeSpec.  Must be compatible with the
-     * `TypeSpec` contained in `encoded`.  (Note: the encoding for the TypeSpec
+     * {@code TypeSpec} contained in {@code encoded}.  (Note: the encoding for the TypeSpec
      * may change in future versions of TensorFlow.)
      */
     public final String metadata;