docs: regenerate javadoc, update common templates (#35)

googleapis · Nov 19, 2019 · 9d8bb12 · 9d8bb12
1 parent 772ca94
commit 9d8bb12
Show file tree

Hide file tree

Showing 11 changed files with 59 additions and 47 deletions.
diff --git a/.github/release-please.yml b/.github/release-please.yml
@@ -1 +1,2 @@
 releaseType: java-yoshi
+bumpMinorPreMajor: true
diff --git a/.kokoro/build.sh b/.kokoro/build.sh
@@ -27,6 +27,7 @@ echo ${JOB_TYPE}
 mvn install -B -V \
   -DskipTests=true \
   -Dclirr.skip=true \
+  -Denforcer.skip=true \
   -Dmaven.javadoc.skip=true \
   -Dgcloud.download.skip=true \
   -T 1C
@@ -38,7 +39,7 @@ fi
 
 case ${JOB_TYPE} in
 test)
-    mvn test -B -Dclirr.skip=true
+    mvn test -B -Dclirr.skip=true -Denforcer.skip=true
     bash ${KOKORO_GFILE_DIR}/codecov.sh
     bash .kokoro/coerce_logs.sh
     ;;
@@ -49,12 +50,17 @@ javadoc)
     mvn javadoc:javadoc javadoc:test-javadoc
     ;;
 integration)
-    mvn -B ${INTEGRATION_TEST_ARGS} -DtrimStackTrace=false -Dclirr.skip=true -fae verify
+    mvn -B ${INTEGRATION_TEST_ARGS} \
+      -DtrimStackTrace=false \
+      -Dclirr.skip=true \
+      -Denforcer.skip=true \
+      -fae \
+      verify
     bash .kokoro/coerce_logs.sh
     ;;
 clirr)
-    mvn -B clirr:check
+    mvn -B -Denforcer.skip=true clirr:check
     ;;
 *)
     ;;
-esac
+esac
diff --git a/.kokoro/dependencies.sh b/.kokoro/dependencies.sh
@@ -23,5 +23,9 @@ echo $JOB_TYPE
 
 export MAVEN_OPTS="-Xmx1024m -XX:MaxPermSize=128m"
 
-mvn install -DskipTests=true -B -V
+# this should run maven enforcer
+mvn install -B -V \
+  -DskipTests=true \
+  -Dclirr.skip=true
+
 mvn -B dependency:analyze -DfailOnWarning=true
diff --git a/...ng/src/test/java/com/google/cloud/datalabeling/v1beta1/DataLabelingServiceClientTest.java b/...ng/src/test/java/com/google/cloud/datalabeling/v1beta1/DataLabelingServiceClientTest.java
@@ -44,6 +44,7 @@
 import java.io.IOException;
 import java.util.Arrays;
 import java.util.List;
+import java.util.UUID;
 import java.util.concurrent.ExecutionException;
 import org.junit.After;
 import org.junit.AfterClass;
@@ -64,7 +65,7 @@ public static void startStaticServer() {
     mockDataLabelingService = new MockDataLabelingService();
     serviceHelper =
         new MockServiceHelper(
-            "in-process-1", Arrays.<MockGrpcService>asList(mockDataLabelingService));
+            UUID.randomUUID().toString(), Arrays.<MockGrpcService>asList(mockDataLabelingService));
     serviceHelper.start();
   }
 

diff --git a/...ng-v1beta1/src/main/java/com/google/cloud/datalabeling/v1beta1/HumanAnnotationConfig.java b/...ng-v1beta1/src/main/java/com/google/cloud/datalabeling/v1beta1/HumanAnnotationConfig.java
@@ -187,7 +187,7 @@ public static final com.google.protobuf.Descriptors.Descriptor getDescriptor() {
    *
    *
    * <pre>
-   * Required except for LabelAudio case. Instruction resource name.
+   * Required. Instruction resource name.
    * </pre>
    *
    * <code>string instruction = 1;</code>
@@ -207,7 +207,7 @@ public java.lang.String getInstruction() {
    *
    *
    * <pre>
-   * Required except for LabelAudio case. Instruction resource name.
+   * Required. Instruction resource name.
    * </pre>
    *
    * <code>string instruction = 1;</code>
@@ -371,7 +371,7 @@ public com.google.protobuf.ByteString getLabelGroupBytes() {
    * [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt).
    * Default value is en-US.
    * Only need to set this when task is language related. For example, French
-   * text classification or Chinese audio transcription.
+   * text classification.
    * </pre>
    *
    * <code>string language_code = 5;</code>
@@ -395,7 +395,7 @@ public java.lang.String getLanguageCode() {
    * [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt).
    * Default value is en-US.
    * Only need to set this when task is language related. For example, French
-   * text classification or Chinese audio transcription.
+   * text classification.
    * </pre>
    *
    * <code>string language_code = 5;</code>
@@ -1075,7 +1075,7 @@ public Builder mergeFrom(
      *
      *
      * <pre>
-     * Required except for LabelAudio case. Instruction resource name.
+     * Required. Instruction resource name.
      * </pre>
      *
      * <code>string instruction = 1;</code>
@@ -1095,7 +1095,7 @@ public java.lang.String getInstruction() {
      *
      *
      * <pre>
-     * Required except for LabelAudio case. Instruction resource name.
+     * Required. Instruction resource name.
      * </pre>
      *
      * <code>string instruction = 1;</code>
@@ -1115,7 +1115,7 @@ public com.google.protobuf.ByteString getInstructionBytes() {
      *
      *
      * <pre>
-     * Required except for LabelAudio case. Instruction resource name.
+     * Required. Instruction resource name.
      * </pre>
      *
      * <code>string instruction = 1;</code>
@@ -1133,7 +1133,7 @@ public Builder setInstruction(java.lang.String value) {
      *
      *
      * <pre>
-     * Required except for LabelAudio case. Instruction resource name.
+     * Required. Instruction resource name.
      * </pre>
      *
      * <code>string instruction = 1;</code>
@@ -1148,7 +1148,7 @@ public Builder clearInstruction() {
      *
      *
      * <pre>
-     * Required except for LabelAudio case. Instruction resource name.
+     * Required. Instruction resource name.
      * </pre>
      *
      * <code>string instruction = 1;</code>
@@ -1475,7 +1475,7 @@ public Builder setLabelGroupBytes(com.google.protobuf.ByteString value) {
      * [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt).
      * Default value is en-US.
      * Only need to set this when task is language related. For example, French
-     * text classification or Chinese audio transcription.
+     * text classification.
      * </pre>
      *
      * <code>string language_code = 5;</code>
@@ -1499,7 +1499,7 @@ public java.lang.String getLanguageCode() {
      * [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt).
      * Default value is en-US.
      * Only need to set this when task is language related. For example, French
-     * text classification or Chinese audio transcription.
+     * text classification.
      * </pre>
      *
      * <code>string language_code = 5;</code>
@@ -1523,7 +1523,7 @@ public com.google.protobuf.ByteString getLanguageCodeBytes() {
      * [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt).
      * Default value is en-US.
      * Only need to set this when task is language related. For example, French
-     * text classification or Chinese audio transcription.
+     * text classification.
      * </pre>
      *
      * <code>string language_code = 5;</code>
@@ -1545,7 +1545,7 @@ public Builder setLanguageCode(java.lang.String value) {
      * [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt).
      * Default value is en-US.
      * Only need to set this when task is language related. For example, French
-     * text classification or Chinese audio transcription.
+     * text classification.
      * </pre>
      *
      * <code>string language_code = 5;</code>
@@ -1564,7 +1564,7 @@ public Builder clearLanguageCode() {
      * [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt).
      * Default value is en-US.
      * Only need to set this when task is language related. For example, French
-     * text classification or Chinese audio transcription.
+     * text classification.
      * </pre>
      *
      * <code>string language_code = 5;</code>

diff --git a/...1/src/main/java/com/google/cloud/datalabeling/v1beta1/HumanAnnotationConfigOrBuilder.java b/...1/src/main/java/com/google/cloud/datalabeling/v1beta1/HumanAnnotationConfigOrBuilder.java
@@ -27,7 +27,7 @@ public interface HumanAnnotationConfigOrBuilder
    *
    *
    * <pre>
-   * Required except for LabelAudio case. Instruction resource name.
+   * Required. Instruction resource name.
    * </pre>
    *
    * <code>string instruction = 1;</code>
@@ -37,7 +37,7 @@ public interface HumanAnnotationConfigOrBuilder
    *
    *
    * <pre>
-   * Required except for LabelAudio case. Instruction resource name.
+   * Required. Instruction resource name.
    * </pre>
    *
    * <code>string instruction = 1;</code>
@@ -123,7 +123,7 @@ public interface HumanAnnotationConfigOrBuilder
    * [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt).
    * Default value is en-US.
    * Only need to set this when task is language related. For example, French
-   * text classification or Chinese audio transcription.
+   * text classification.
    * </pre>
    *
    * <code>string language_code = 5;</code>
@@ -137,7 +137,7 @@ public interface HumanAnnotationConfigOrBuilder
    * [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt).
    * Default value is en-US.
    * Only need to set this when task is language related. For example, French
-   * text classification or Chinese audio transcription.
+   * text classification.
    * </pre>
    *
    * <code>string language_code = 5;</code>

diff --git a/...atalabeling-v1beta1/src/main/java/com/google/cloud/datalabeling/v1beta1/OutputConfig.java b/...atalabeling-v1beta1/src/main/java/com/google/cloud/datalabeling/v1beta1/OutputConfig.java
@@ -183,7 +183,7 @@ public DestinationCase getDestinationCase() {
    *
    * <pre>
    * Output to a file in Cloud Storage. Should be used for labeling output
-   * other thanimage segmentation.
+   * other than image segmentation.
    * </pre>
    *
    * <code>.google.cloud.datalabeling.v1beta1.GcsDestination gcs_destination = 1;</code>
@@ -196,7 +196,7 @@ public boolean hasGcsDestination() {
    *
    * <pre>
    * Output to a file in Cloud Storage. Should be used for labeling output
-   * other thanimage segmentation.
+   * other than image segmentation.
    * </pre>
    *
    * <code>.google.cloud.datalabeling.v1beta1.GcsDestination gcs_destination = 1;</code>
@@ -212,7 +212,7 @@ public com.google.cloud.datalabeling.v1beta1.GcsDestination getGcsDestination()
    *
    * <pre>
    * Output to a file in Cloud Storage. Should be used for labeling output
-   * other thanimage segmentation.
+   * other than image segmentation.
    * </pre>
    *
    * <code>.google.cloud.datalabeling.v1beta1.GcsDestination gcs_destination = 1;</code>
@@ -675,7 +675,7 @@ public Builder clearDestination() {
      *
      * <pre>
      * Output to a file in Cloud Storage. Should be used for labeling output
-     * other thanimage segmentation.
+     * other than image segmentation.
      * </pre>
      *
      * <code>.google.cloud.datalabeling.v1beta1.GcsDestination gcs_destination = 1;</code>
@@ -688,7 +688,7 @@ public boolean hasGcsDestination() {
      *
      * <pre>
      * Output to a file in Cloud Storage. Should be used for labeling output
-     * other thanimage segmentation.
+     * other than image segmentation.
      * </pre>
      *
      * <code>.google.cloud.datalabeling.v1beta1.GcsDestination gcs_destination = 1;</code>
@@ -711,7 +711,7 @@ public com.google.cloud.datalabeling.v1beta1.GcsDestination getGcsDestination()
      *
      * <pre>
      * Output to a file in Cloud Storage. Should be used for labeling output
-     * other thanimage segmentation.
+     * other than image segmentation.
      * </pre>
      *
      * <code>.google.cloud.datalabeling.v1beta1.GcsDestination gcs_destination = 1;</code>
@@ -734,7 +734,7 @@ public Builder setGcsDestination(com.google.cloud.datalabeling.v1beta1.GcsDestin
      *
      * <pre>
      * Output to a file in Cloud Storage. Should be used for labeling output
-     * other thanimage segmentation.
+     * other than image segmentation.
      * </pre>
      *
      * <code>.google.cloud.datalabeling.v1beta1.GcsDestination gcs_destination = 1;</code>
@@ -755,7 +755,7 @@ public Builder setGcsDestination(
      *
      * <pre>
      * Output to a file in Cloud Storage. Should be used for labeling output
-     * other thanimage segmentation.
+     * other than image segmentation.
      * </pre>
      *
      * <code>.google.cloud.datalabeling.v1beta1.GcsDestination gcs_destination = 1;</code>
@@ -788,7 +788,7 @@ public Builder mergeGcsDestination(com.google.cloud.datalabeling.v1beta1.GcsDest
      *
      * <pre>
      * Output to a file in Cloud Storage. Should be used for labeling output
-     * other thanimage segmentation.
+     * other than image segmentation.
      * </pre>
      *
      * <code>.google.cloud.datalabeling.v1beta1.GcsDestination gcs_destination = 1;</code>
@@ -814,7 +814,7 @@ public Builder clearGcsDestination() {
      *
      * <pre>
      * Output to a file in Cloud Storage. Should be used for labeling output
-     * other thanimage segmentation.
+     * other than image segmentation.
      * </pre>
      *
      * <code>.google.cloud.datalabeling.v1beta1.GcsDestination gcs_destination = 1;</code>
@@ -827,7 +827,7 @@ public com.google.cloud.datalabeling.v1beta1.GcsDestination.Builder getGcsDestin
      *
      * <pre>
      * Output to a file in Cloud Storage. Should be used for labeling output
-     * other thanimage segmentation.
+     * other than image segmentation.
      * </pre>
      *
      * <code>.google.cloud.datalabeling.v1beta1.GcsDestination gcs_destination = 1;</code>
@@ -848,7 +848,7 @@ public com.google.cloud.datalabeling.v1beta1.GcsDestination.Builder getGcsDestin
      *
      * <pre>
      * Output to a file in Cloud Storage. Should be used for labeling output
-     * other thanimage segmentation.
+     * other than image segmentation.
      * </pre>
      *
      * <code>.google.cloud.datalabeling.v1beta1.GcsDestination gcs_destination = 1;</code>

diff --git a/...ng-v1beta1/src/main/java/com/google/cloud/datalabeling/v1beta1/OutputConfigOrBuilder.java b/...ng-v1beta1/src/main/java/com/google/cloud/datalabeling/v1beta1/OutputConfigOrBuilder.java
@@ -28,7 +28,7 @@ public interface OutputConfigOrBuilder
    *
    * <pre>
    * Output to a file in Cloud Storage. Should be used for labeling output
-   * other thanimage segmentation.
+   * other than image segmentation.
    * </pre>
    *
    * <code>.google.cloud.datalabeling.v1beta1.GcsDestination gcs_destination = 1;</code>
@@ -39,7 +39,7 @@ public interface OutputConfigOrBuilder
    *
    * <pre>
    * Output to a file in Cloud Storage. Should be used for labeling output
-   * other thanimage segmentation.
+   * other than image segmentation.
    * </pre>
    *
    * <code>.google.cloud.datalabeling.v1beta1.GcsDestination gcs_destination = 1;</code>
@@ -50,7 +50,7 @@ public interface OutputConfigOrBuilder
    *
    * <pre>
    * Output to a file in Cloud Storage. Should be used for labeling output
-   * other thanimage segmentation.
+   * other than image segmentation.
    * </pre>
    *
    * <code>.google.cloud.datalabeling.v1beta1.GcsDestination gcs_destination = 1;</code>

diff --git a/...cloud-datalabeling-v1beta1/src/main/proto/google/cloud/datalabeling/v1beta1/dataset.proto b/...cloud-datalabeling-v1beta1/src/main/proto/google/cloud/datalabeling/v1beta1/dataset.proto
@@ -135,7 +135,7 @@ message OutputConfig {
   // Required. Location to output data to.
   oneof destination {
     // Output to a file in Cloud Storage. Should be used for labeling output
-    // other thanimage segmentation.
+    // other than image segmentation.
     GcsDestination gcs_destination = 1;
 
     // Output to a folder in Cloud Storage. Should be used for image

diff --git a/...ng-v1beta1/src/main/proto/google/cloud/datalabeling/v1beta1/human_annotation_config.proto b/...ng-v1beta1/src/main/proto/google/cloud/datalabeling/v1beta1/human_annotation_config.proto
@@ -39,7 +39,7 @@ enum StringAggregationType {
 
 // Configuration for how human labeling task should be done.
 message HumanAnnotationConfig {
-  // Required except for LabelAudio case. Instruction resource name.
+  // Required. Instruction resource name.
   string instruction = 1;
 
   // Required. A human-readable name for AnnotatedDataset defined by
@@ -59,7 +59,7 @@ message HumanAnnotationConfig {
   // [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt).
   // Default value is en-US.
   // Only need to set this when task is language related. For example, French
-  // text classification or Chinese audio transcription.
+  // text classification.
   string language_code = 5;
 
   // Optional. Replication of questions. Each question will be sent to up to