docs: regenerate javadocs from protos (#69)

This PR was generated using Autosynth. 🌈 Synth log will be available here: https://source.cloud.google.com/results/invocations/7190c05a-9947-4da8-aaea-64adccb6e46f/targets - [ ] To automatically regenerate this PR, check this box. PiperOrigin-RevId: 338275151 Source-Link: googleapis/googleapis@29b7899
googleapis · Nov 2, 2020 · 1759fe7 · 1759fe7
1 parent 83f3709
commit 1759fe7
Show file tree

Hide file tree

Showing 12 changed files with 168 additions and 140 deletions.
diff --git a/proto-google-common-protos/src/main/java/com/google/type/Color.java b/proto-google-common-protos/src/main/java/com/google/type/Color.java
@@ -33,6 +33,9 @@
  * that should be used to interpret the RGB value (e.g. sRGB, Adobe RGB,
  * DCI-P3, BT.2020, etc.). By default, applications SHOULD assume the sRGB color
  * space.
+ * Note: when color equality needs to be decided, implementations, unless
+ * documented otherwise, will treat two colors to be equal if all their red,
+ * green, blue and alpha values each differ by at most 1e-5.
  * Example (Java):
  *      import com.google.type.Color;
  *      // ...
@@ -562,6 +565,9 @@ protected Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.Build
    * that should be used to interpret the RGB value (e.g. sRGB, Adobe RGB,
    * DCI-P3, BT.2020, etc.). By default, applications SHOULD assume the sRGB color
    * space.
+   * Note: when color equality needs to be decided, implementations, unless
+   * documented otherwise, will treat two colors to be equal if all their red,
+   * green, blue and alpha values each differ by at most 1e-5.
    * Example (Java):
    *      import com.google.type.Color;
    *      // ...

diff --git a/proto-google-common-protos/src/main/java/com/google/type/Date.java b/proto-google-common-protos/src/main/java/com/google/type/Date.java
@@ -22,13 +22,15 @@
  *
  *
  * <pre>
- * Represents a whole or partial calendar date, e.g. a birthday. The time of day
- * and time zone are either specified elsewhere or are not significant. The date
- * is relative to the Proleptic Gregorian Calendar. This can represent:
- * * A full date, with non-zero year, month and day values
- * * A month and day value, with a zero year, e.g. an anniversary
+ * Represents a whole or partial calendar date, such as a birthday. The time of
+ * day and time zone are either specified elsewhere or are insignificant. The
+ * date is relative to the Gregorian Calendar. This can represent one of the
+ * following:
+ * * A full date, with non-zero year, month, and day values
+ * * A month and day value, with a zero year, such as an anniversary
  * * A year on its own, with zero month and day values
- * * A year and month value, with a zero day, e.g. a credit card expiration date
+ * * A year and month value, with a zero day, such as a credit card expiration
+ * date
  * Related types are [google.type.TimeOfDay][google.type.TimeOfDay] and `google.protobuf.Timestamp`.
  * </pre>
  *
@@ -127,7 +129,7 @@ public static final com.google.protobuf.Descriptors.Descriptor getDescriptor() {
    *
    *
    * <pre>
-   * Year of date. Must be from 1 to 9999, or 0 if specifying a date without
+   * Year of the date. Must be from 1 to 9999, or 0 to specify a date without
    * a year.
    * </pre>
    *
@@ -146,7 +148,7 @@ public int getYear() {
    *
    *
    * <pre>
-   * Month of year. Must be from 1 to 12, or 0 if specifying a year without a
+   * Month of a year. Must be from 1 to 12, or 0 to specify a year without a
    * month and day.
    * </pre>
    *
@@ -165,8 +167,8 @@ public int getMonth() {
    *
    *
    * <pre>
-   * Day of month. Must be from 1 to 31 and valid for the year and month, or 0
-   * if specifying a year by itself or a year and month where the day is not
+   * Day of a month. Must be from 1 to 31 and valid for the year and month, or 0
+   * to specify a year by itself or a year and month where the day isn't
    * significant.
    * </pre>
    *
@@ -358,13 +360,15 @@ protected Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.Build
    *
    *
    * <pre>
-   * Represents a whole or partial calendar date, e.g. a birthday. The time of day
-   * and time zone are either specified elsewhere or are not significant. The date
-   * is relative to the Proleptic Gregorian Calendar. This can represent:
-   * * A full date, with non-zero year, month and day values
-   * * A month and day value, with a zero year, e.g. an anniversary
+   * Represents a whole or partial calendar date, such as a birthday. The time of
+   * day and time zone are either specified elsewhere or are insignificant. The
+   * date is relative to the Gregorian Calendar. This can represent one of the
+   * following:
+   * * A full date, with non-zero year, month, and day values
+   * * A month and day value, with a zero year, such as an anniversary
    * * A year on its own, with zero month and day values
-   * * A year and month value, with a zero day, e.g. a credit card expiration date
+   * * A year and month value, with a zero day, such as a credit card expiration
+   * date
    * Related types are [google.type.TimeOfDay][google.type.TimeOfDay] and `google.protobuf.Timestamp`.
    * </pre>
    *
@@ -529,7 +533,7 @@ public Builder mergeFrom(
      *
      *
      * <pre>
-     * Year of date. Must be from 1 to 9999, or 0 if specifying a date without
+     * Year of the date. Must be from 1 to 9999, or 0 to specify a date without
      * a year.
      * </pre>
      *
@@ -545,7 +549,7 @@ public int getYear() {
      *
      *
      * <pre>
-     * Year of date. Must be from 1 to 9999, or 0 if specifying a date without
+     * Year of the date. Must be from 1 to 9999, or 0 to specify a date without
      * a year.
      * </pre>
      *
@@ -564,7 +568,7 @@ public Builder setYear(int value) {
      *
      *
      * <pre>
-     * Year of date. Must be from 1 to 9999, or 0 if specifying a date without
+     * Year of the date. Must be from 1 to 9999, or 0 to specify a date without
      * a year.
      * </pre>
      *
@@ -584,7 +588,7 @@ public Builder clearYear() {
      *
      *
      * <pre>
-     * Month of year. Must be from 1 to 12, or 0 if specifying a year without a
+     * Month of a year. Must be from 1 to 12, or 0 to specify a year without a
      * month and day.
      * </pre>
      *
@@ -600,7 +604,7 @@ public int getMonth() {
      *
      *
      * <pre>
-     * Month of year. Must be from 1 to 12, or 0 if specifying a year without a
+     * Month of a year. Must be from 1 to 12, or 0 to specify a year without a
      * month and day.
      * </pre>
      *
@@ -619,7 +623,7 @@ public Builder setMonth(int value) {
      *
      *
      * <pre>
-     * Month of year. Must be from 1 to 12, or 0 if specifying a year without a
+     * Month of a year. Must be from 1 to 12, or 0 to specify a year without a
      * month and day.
      * </pre>
      *
@@ -639,8 +643,8 @@ public Builder clearMonth() {
      *
      *
      * <pre>
-     * Day of month. Must be from 1 to 31 and valid for the year and month, or 0
-     * if specifying a year by itself or a year and month where the day is not
+     * Day of a month. Must be from 1 to 31 and valid for the year and month, or 0
+     * to specify a year by itself or a year and month where the day isn't
      * significant.
      * </pre>
      *
@@ -656,8 +660,8 @@ public int getDay() {
      *
      *
      * <pre>
-     * Day of month. Must be from 1 to 31 and valid for the year and month, or 0
-     * if specifying a year by itself or a year and month where the day is not
+     * Day of a month. Must be from 1 to 31 and valid for the year and month, or 0
+     * to specify a year by itself or a year and month where the day isn't
      * significant.
      * </pre>
      *
@@ -676,8 +680,8 @@ public Builder setDay(int value) {
      *
      *
      * <pre>
-     * Day of month. Must be from 1 to 31 and valid for the year and month, or 0
-     * if specifying a year by itself or a year and month where the day is not
+     * Day of a month. Must be from 1 to 31 and valid for the year and month, or 0
+     * to specify a year by itself or a year and month where the day isn't
      * significant.
      * </pre>
      *

diff --git a/proto-google-common-protos/src/main/java/com/google/type/DateOrBuilder.java b/proto-google-common-protos/src/main/java/com/google/type/DateOrBuilder.java
@@ -27,7 +27,7 @@ public interface DateOrBuilder
    *
    *
    * <pre>
-   * Year of date. Must be from 1 to 9999, or 0 if specifying a date without
+   * Year of the date. Must be from 1 to 9999, or 0 to specify a date without
    * a year.
    * </pre>
    *
@@ -41,7 +41,7 @@ public interface DateOrBuilder
    *
    *
    * <pre>
-   * Month of year. Must be from 1 to 12, or 0 if specifying a year without a
+   * Month of a year. Must be from 1 to 12, or 0 to specify a year without a
    * month and day.
    * </pre>
    *
@@ -55,8 +55,8 @@ public interface DateOrBuilder
    *
    *
    * <pre>
-   * Day of month. Must be from 1 to 31 and valid for the year and month, or 0
-   * if specifying a year by itself or a year and month where the day is not
+   * Day of a month. Must be from 1 to 31 and valid for the year and month, or 0
+   * to specify a year by itself or a year and month where the day isn't
    * significant.
    * </pre>
    *

diff --git a/proto-google-common-protos/src/main/java/com/google/type/DayOfWeek.java b/proto-google-common-protos/src/main/java/com/google/type/DayOfWeek.java
@@ -22,7 +22,7 @@
  *
  *
  * <pre>
- * Represents a day of week.
+ * Represents a day of the week.
  * </pre>
  *
  * Protobuf enum {@code google.type.DayOfWeek}
@@ -32,7 +32,7 @@ public enum DayOfWeek implements com.google.protobuf.ProtocolMessageEnum {
    *
    *
    * <pre>
-   * The unspecified day-of-week.
+   * The day of the week is unspecified.
    * </pre>
    *
    * <code>DAY_OF_WEEK_UNSPECIFIED = 0;</code>
@@ -42,7 +42,7 @@ public enum DayOfWeek implements com.google.protobuf.ProtocolMessageEnum {
    *
    *
    * <pre>
-   * The day-of-week of Monday.
+   * Monday
    * </pre>
    *
    * <code>MONDAY = 1;</code>
@@ -52,7 +52,7 @@ public enum DayOfWeek implements com.google.protobuf.ProtocolMessageEnum {
    *
    *
    * <pre>
-   * The day-of-week of Tuesday.
+   * Tuesday
    * </pre>
    *
    * <code>TUESDAY = 2;</code>
@@ -62,7 +62,7 @@ public enum DayOfWeek implements com.google.protobuf.ProtocolMessageEnum {
    *
    *
    * <pre>
-   * The day-of-week of Wednesday.
+   * Wednesday
    * </pre>
    *
    * <code>WEDNESDAY = 3;</code>
@@ -72,7 +72,7 @@ public enum DayOfWeek implements com.google.protobuf.ProtocolMessageEnum {
    *
    *
    * <pre>
-   * The day-of-week of Thursday.
+   * Thursday
    * </pre>
    *
    * <code>THURSDAY = 4;</code>
@@ -82,7 +82,7 @@ public enum DayOfWeek implements com.google.protobuf.ProtocolMessageEnum {
    *
    *
    * <pre>
-   * The day-of-week of Friday.
+   * Friday
    * </pre>
    *
    * <code>FRIDAY = 5;</code>
@@ -92,7 +92,7 @@ public enum DayOfWeek implements com.google.protobuf.ProtocolMessageEnum {
    *
    *
    * <pre>
-   * The day-of-week of Saturday.
+   * Saturday
    * </pre>
    *
    * <code>SATURDAY = 6;</code>
@@ -102,7 +102,7 @@ public enum DayOfWeek implements com.google.protobuf.ProtocolMessageEnum {
    *
    *
    * <pre>
-   * The day-of-week of Sunday.
+   * Sunday
    * </pre>
    *
    * <code>SUNDAY = 7;</code>
@@ -115,7 +115,7 @@ public enum DayOfWeek implements com.google.protobuf.ProtocolMessageEnum {
    *
    *
    * <pre>
-   * The unspecified day-of-week.
+   * The day of the week is unspecified.
    * </pre>
    *
    * <code>DAY_OF_WEEK_UNSPECIFIED = 0;</code>
@@ -125,7 +125,7 @@ public enum DayOfWeek implements com.google.protobuf.ProtocolMessageEnum {
    *
    *
    * <pre>
-   * The day-of-week of Monday.
+   * Monday
    * </pre>
    *
    * <code>MONDAY = 1;</code>
@@ -135,7 +135,7 @@ public enum DayOfWeek implements com.google.protobuf.ProtocolMessageEnum {
    *
    *
    * <pre>
-   * The day-of-week of Tuesday.
+   * Tuesday
    * </pre>
    *
    * <code>TUESDAY = 2;</code>
@@ -145,7 +145,7 @@ public enum DayOfWeek implements com.google.protobuf.ProtocolMessageEnum {
    *
    *
    * <pre>
-   * The day-of-week of Wednesday.
+   * Wednesday
    * </pre>
    *
    * <code>WEDNESDAY = 3;</code>
@@ -155,7 +155,7 @@ public enum DayOfWeek implements com.google.protobuf.ProtocolMessageEnum {
    *
    *
    * <pre>
-   * The day-of-week of Thursday.
+   * Thursday
    * </pre>
    *
    * <code>THURSDAY = 4;</code>
@@ -165,7 +165,7 @@ public enum DayOfWeek implements com.google.protobuf.ProtocolMessageEnum {
    *
    *
    * <pre>
-   * The day-of-week of Friday.
+   * Friday
    * </pre>
    *
    * <code>FRIDAY = 5;</code>
@@ -175,7 +175,7 @@ public enum DayOfWeek implements com.google.protobuf.ProtocolMessageEnum {
    *
    *
    * <pre>
-   * The day-of-week of Saturday.
+   * Saturday
    * </pre>
    *
    * <code>SATURDAY = 6;</code>
@@ -185,7 +185,7 @@ public enum DayOfWeek implements com.google.protobuf.ProtocolMessageEnum {
    *
    *
    * <pre>
-   * The day-of-week of Sunday.
+   * Sunday
    * </pre>
    *
    * <code>SUNDAY = 7;</code>