Fix MissingSummary errorprone Warnings Across Codebase

Author: stankiewicz

buildSrc/src/main/groovy/org/apache/beam/gradle/BeamModulePlugin.groovy

@@ -1556,7 +1556,6 @@ class BeamModulePlugin implements Plugin<Project> {
             "JavaUtilDate",
             "JodaConstructors",
             "MalformedInlineTag",
-            "MissingSummary",
             "MixedMutabilityReturnType",
             "PreferJavaTimeOverload",
             "MutablePublicArray",

it/google-cloud-platform/src/main/java/org/apache/beam/it/gcp/datastream/DatastreamResourceManager.java

@@ -182,9 +182,10 @@ private synchronized ConnectionProfile createJDBCSourceConnectionProfile(
   }
 
   /**
+   * Returns a SourceConfig object which is required to configure a Stream.
+   *
    * @param sourceConnectionProfileId The ID of the connection profile.
    * @param source An object representing the JDBC source.
-   * @return a SourceConfig object which is required to configure a Stream.
    */
   public synchronized SourceConfig buildSourceConfig(
       String sourceConnectionProfileId, JDBCSource source) {
@@ -214,11 +215,12 @@ public synchronized SourceConfig buildSourceConfig(
   }
 
   /**
+   * Returns a Datastream GCS destination connection profile.
+   *
    * @param connectionProfileId The ID of the GCS connection profile.
    * @param gcsBucketName The GCS Bucket to connect to.
    * @param gcsRootPath The Path prefix to specific gcs location. Can either be empty or must start
    *     with '/'.
-   * @return A Datastream GCS destination connection profile.
    */
   public synchronized ConnectionProfile createGCSDestinationConnectionProfile(
       String connectionProfileId, String gcsBucketName, String gcsRootPath) {
@@ -266,11 +268,12 @@ public synchronized ConnectionProfile createGCSDestinationConnectionProfile(
   }
 
   /**
+   * Returns a DestinationConfig object representing a GCS destination configuration.
+   *
    * @param connectionProfileId The ID of the connection profile.
    * @param path The Path prefix to specific GCS location. Can either be empty or must start with
    *     '/'.
    * @param destinationOutputFormat The format of the files written to GCS.
-   * @return A DestinationConfig object representing a GCS destination configuration.
    */
   public synchronized DestinationConfig buildGCSDestinationConfig(
       String connectionProfileId, String path, DestinationOutputFormat destinationOutputFormat) {
@@ -294,8 +297,9 @@ public synchronized DestinationConfig buildGCSDestinationConfig(
   }
 
   /**
+   * Returns a Datastream BigQuery destination connection profile.
+   *
    * @param connectionProfileId The ID of the connection profile.
-   * @return A Datastream BigQuery destination connection profile.
    */
   public synchronized ConnectionProfile createBQDestinationConnectionProfile(
       String connectionProfileId) {
@@ -334,10 +338,11 @@ public synchronized ConnectionProfile createBQDestinationConnectionProfile(
   }
 
   /**
+   * Returns a DestinationConfig object representing a BigQuery destination configuration.
+   *
    * @param connectionProfileId The ID of the connection profile.
    * @param stalenessLimitSeconds The desired data freshness in seconds.
    * @param datasetId The ID of the BigQuery dataset.
-   * @return A DestinationConfig object representing a BigQuery destination configuration.
    */
   public synchronized DestinationConfig buildBQDestinationConfig(
       String connectionProfileId, long stalenessLimitSeconds, String datasetId) {
@@ -358,10 +363,11 @@ public synchronized DestinationConfig buildBQDestinationConfig(
   }
 
   /**
+   * Returns a Datastream stream object.
+   *
    * @param streamId The ID of the stream.
    * @param sourceConfig A SourceConfig object representing the source configuration.
    * @param destinationConfig A DestinationConfig object representing the destination configuration.
-   * @return A Datastream stream object.
    */
   public synchronized Stream createStream(
       String streamId, SourceConfig sourceConfig, DestinationConfig destinationConfig) {

it/truthmatchers/src/main/java/org/apache/beam/it/truthmatchers/ListAccumulator.java

@@ -54,7 +54,7 @@ public int count() {
     return this.backingList.size();
   }
 
-  /** @return the internal backing list being accumulated. */
+  /** Returns the internal backing list being accumulated. */
   public List<T> getBackingList() {
     return this.backingList;
   }

runners/core-java/src/main/java/org/apache/beam/runners/core/DoFnRunner.java

@@ -64,8 +64,9 @@ public interface DoFnRunner<InputT extends @Nullable Object, OutputT extends @Nu
       BoundedWindow window, Instant timestamp, KeyT key);
 
   /**
+   * Returns the underlying fn instance.
+   *
    * @since 2.5.0
-   * @return the underlying fn instance.
    */
   DoFn<InputT, OutputT> getFn();
 }

runners/core-java/src/main/java/org/apache/beam/runners/core/PushbackSideInputDoFnRunner.java

@@ -61,8 +61,9 @@ <KeyT> void onTimer(
   void finishBundle();
 
   /**
+   * Returns the underlying fn instance.
+   *
    * @since 2.5.0
-   * @return the underlying fn instance.
    */
   DoFn<InputT, OutputT> getFn();
 }

runners/core-java/src/main/java/org/apache/beam/runners/core/metrics/BoundedTrieData.java

@@ -276,7 +276,7 @@ public synchronized boolean contains(@Nonnull List<String> value) {
     }
   }
 
-  /** @return true if this {@link BoundedTrieData} is empty else false. */
+  /** Returns true if this {@link BoundedTrieData} is empty else false. */
   public boolean isEmpty() {
     return (root == null || root.children.isEmpty()) && (singleton == null || singleton.isEmpty());
   }

runners/core-java/src/main/java/org/apache/beam/runners/core/metrics/MonitoringInfoMetricName.java

@@ -74,7 +74,7 @@ public String getName() {
     return urn.split(":", 2)[1];
   }
 
-  /** @return the urn of this MonitoringInfo metric. */
+  /** Returns the urn of this MonitoringInfo metric. */
   public String getUrn() {
     return this.urn;
   }

runners/core-java/src/main/java/org/apache/beam/runners/core/metrics/SimpleStateRegistry.java

@@ -45,7 +45,7 @@ public void reset() {
     }
   }
 
-  /** @return Execution Time MonitoringInfos based on the tracked start or finish function. */
+  /** Returns execution Time MonitoringInfos based on the tracked start or finish function. */
   public List<MonitoringInfo> getExecutionTimeMonitoringInfos() {
     List<MonitoringInfo> monitoringInfos = new ArrayList<MonitoringInfo>();
     for (SimpleExecutionState state : executionStates) {

runners/core-java/src/main/java/org/apache/beam/runners/core/triggers/AfterWatermarkStateMachine.java

@@ -66,7 +66,7 @@ public static FromEndOfWindow pastEndOfWindow() {
     return new FromEndOfWindow();
   }
 
-  /** @see AfterWatermarkStateMachine */
+  /** See {@link AfterWatermarkStateMachine}. */
   public static class AfterWatermarkEarlyAndLate extends TriggerStateMachine {
 
     private static final int EARLY_INDEX = 0;

runners/google-cloud-dataflow-java/src/main/java/org/apache/beam/runners/dataflow/util/PackageUtil.java

@@ -469,20 +469,20 @@ public PackageAttributes withPackageName(String overridePackageName) {
           getSource(), getBytes(), newDestination, getSize(), getHash());
     }
 
-    /** @return the file to be uploaded, if any */
+    /** Returns the file to be uploaded, if any. */
     public abstract @Nullable File getSource();
 
-    /** @return the bytes to be uploaded, if any */
+    /** Returns the bytes to be uploaded, if any. */
     @SuppressWarnings("mutable")
     public abstract byte @Nullable [] getBytes();
 
-    /** @return the dataflowPackage */
+    /** Returns the dataflowPackage. */
     public abstract DataflowPackage getDestination();
 
-    /** @return the size */
+    /** Returns the size. */
     public abstract long getSize();
 
-    /** @return the hash */
+    /** Returns the hash. */
     public abstract String getHash();
 
     public String getSourceDescription() {