Skip to content
This repository was archived by the owner on Sep 18, 2023. It is now read-only.

Commit 1759fe7

Browse files
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
1 parent 83f3709 commit 1759fe7

File tree

12 files changed

+168
-140
lines changed

12 files changed

+168
-140
lines changed

proto-google-common-protos/src/main/java/com/google/type/Color.java

+6
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,9 @@
3333
* that should be used to interpret the RGB value (e.g. sRGB, Adobe RGB,
3434
* DCI-P3, BT.2020, etc.). By default, applications SHOULD assume the sRGB color
3535
* space.
36+
* Note: when color equality needs to be decided, implementations, unless
37+
* documented otherwise, will treat two colors to be equal if all their red,
38+
* green, blue and alpha values each differ by at most 1e-5.
3639
* Example (Java):
3740
* import com.google.type.Color;
3841
* // ...
@@ -562,6 +565,9 @@ protected Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.Build
562565
* that should be used to interpret the RGB value (e.g. sRGB, Adobe RGB,
563566
* DCI-P3, BT.2020, etc.). By default, applications SHOULD assume the sRGB color
564567
* space.
568+
* Note: when color equality needs to be decided, implementations, unless
569+
* documented otherwise, will treat two colors to be equal if all their red,
570+
* green, blue and alpha values each differ by at most 1e-5.
565571
* Example (Java):
566572
* import com.google.type.Color;
567573
* // ...

proto-google-common-protos/src/main/java/com/google/type/Date.java

+32-28
Original file line numberDiff line numberDiff line change
@@ -22,13 +22,15 @@
2222
*
2323
*
2424
* <pre>
25-
* Represents a whole or partial calendar date, e.g. a birthday. The time of day
26-
* and time zone are either specified elsewhere or are not significant. The date
27-
* is relative to the Proleptic Gregorian Calendar. This can represent:
28-
* * A full date, with non-zero year, month and day values
29-
* * A month and day value, with a zero year, e.g. an anniversary
25+
* Represents a whole or partial calendar date, such as a birthday. The time of
26+
* day and time zone are either specified elsewhere or are insignificant. The
27+
* date is relative to the Gregorian Calendar. This can represent one of the
28+
* following:
29+
* * A full date, with non-zero year, month, and day values
30+
* * A month and day value, with a zero year, such as an anniversary
3031
* * A year on its own, with zero month and day values
31-
* * A year and month value, with a zero day, e.g. a credit card expiration date
32+
* * A year and month value, with a zero day, such as a credit card expiration
33+
* date
3234
* Related types are [google.type.TimeOfDay][google.type.TimeOfDay] and `google.protobuf.Timestamp`.
3335
* </pre>
3436
*
@@ -127,7 +129,7 @@ public static final com.google.protobuf.Descriptors.Descriptor getDescriptor() {
127129
*
128130
*
129131
* <pre>
130-
* Year of date. Must be from 1 to 9999, or 0 if specifying a date without
132+
* Year of the date. Must be from 1 to 9999, or 0 to specify a date without
131133
* a year.
132134
* </pre>
133135
*
@@ -146,7 +148,7 @@ public int getYear() {
146148
*
147149
*
148150
* <pre>
149-
* Month of year. Must be from 1 to 12, or 0 if specifying a year without a
151+
* Month of a year. Must be from 1 to 12, or 0 to specify a year without a
150152
* month and day.
151153
* </pre>
152154
*
@@ -165,8 +167,8 @@ public int getMonth() {
165167
*
166168
*
167169
* <pre>
168-
* Day of month. Must be from 1 to 31 and valid for the year and month, or 0
169-
* if specifying a year by itself or a year and month where the day is not
170+
* Day of a month. Must be from 1 to 31 and valid for the year and month, or 0
171+
* to specify a year by itself or a year and month where the day isn't
170172
* significant.
171173
* </pre>
172174
*
@@ -358,13 +360,15 @@ protected Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.Build
358360
*
359361
*
360362
* <pre>
361-
* Represents a whole or partial calendar date, e.g. a birthday. The time of day
362-
* and time zone are either specified elsewhere or are not significant. The date
363-
* is relative to the Proleptic Gregorian Calendar. This can represent:
364-
* * A full date, with non-zero year, month and day values
365-
* * A month and day value, with a zero year, e.g. an anniversary
363+
* Represents a whole or partial calendar date, such as a birthday. The time of
364+
* day and time zone are either specified elsewhere or are insignificant. The
365+
* date is relative to the Gregorian Calendar. This can represent one of the
366+
* following:
367+
* * A full date, with non-zero year, month, and day values
368+
* * A month and day value, with a zero year, such as an anniversary
366369
* * A year on its own, with zero month and day values
367-
* * A year and month value, with a zero day, e.g. a credit card expiration date
370+
* * A year and month value, with a zero day, such as a credit card expiration
371+
* date
368372
* Related types are [google.type.TimeOfDay][google.type.TimeOfDay] and `google.protobuf.Timestamp`.
369373
* </pre>
370374
*
@@ -529,7 +533,7 @@ public Builder mergeFrom(
529533
*
530534
*
531535
* <pre>
532-
* Year of date. Must be from 1 to 9999, or 0 if specifying a date without
536+
* Year of the date. Must be from 1 to 9999, or 0 to specify a date without
533537
* a year.
534538
* </pre>
535539
*
@@ -545,7 +549,7 @@ public int getYear() {
545549
*
546550
*
547551
* <pre>
548-
* Year of date. Must be from 1 to 9999, or 0 if specifying a date without
552+
* Year of the date. Must be from 1 to 9999, or 0 to specify a date without
549553
* a year.
550554
* </pre>
551555
*
@@ -564,7 +568,7 @@ public Builder setYear(int value) {
564568
*
565569
*
566570
* <pre>
567-
* Year of date. Must be from 1 to 9999, or 0 if specifying a date without
571+
* Year of the date. Must be from 1 to 9999, or 0 to specify a date without
568572
* a year.
569573
* </pre>
570574
*
@@ -584,7 +588,7 @@ public Builder clearYear() {
584588
*
585589
*
586590
* <pre>
587-
* Month of year. Must be from 1 to 12, or 0 if specifying a year without a
591+
* Month of a year. Must be from 1 to 12, or 0 to specify a year without a
588592
* month and day.
589593
* </pre>
590594
*
@@ -600,7 +604,7 @@ public int getMonth() {
600604
*
601605
*
602606
* <pre>
603-
* Month of year. Must be from 1 to 12, or 0 if specifying a year without a
607+
* Month of a year. Must be from 1 to 12, or 0 to specify a year without a
604608
* month and day.
605609
* </pre>
606610
*
@@ -619,7 +623,7 @@ public Builder setMonth(int value) {
619623
*
620624
*
621625
* <pre>
622-
* Month of year. Must be from 1 to 12, or 0 if specifying a year without a
626+
* Month of a year. Must be from 1 to 12, or 0 to specify a year without a
623627
* month and day.
624628
* </pre>
625629
*
@@ -639,8 +643,8 @@ public Builder clearMonth() {
639643
*
640644
*
641645
* <pre>
642-
* Day of month. Must be from 1 to 31 and valid for the year and month, or 0
643-
* if specifying a year by itself or a year and month where the day is not
646+
* Day of a month. Must be from 1 to 31 and valid for the year and month, or 0
647+
* to specify a year by itself or a year and month where the day isn't
644648
* significant.
645649
* </pre>
646650
*
@@ -656,8 +660,8 @@ public int getDay() {
656660
*
657661
*
658662
* <pre>
659-
* Day of month. Must be from 1 to 31 and valid for the year and month, or 0
660-
* if specifying a year by itself or a year and month where the day is not
663+
* Day of a month. Must be from 1 to 31 and valid for the year and month, or 0
664+
* to specify a year by itself or a year and month where the day isn't
661665
* significant.
662666
* </pre>
663667
*
@@ -676,8 +680,8 @@ public Builder setDay(int value) {
676680
*
677681
*
678682
* <pre>
679-
* Day of month. Must be from 1 to 31 and valid for the year and month, or 0
680-
* if specifying a year by itself or a year and month where the day is not
683+
* Day of a month. Must be from 1 to 31 and valid for the year and month, or 0
684+
* to specify a year by itself or a year and month where the day isn't
681685
* significant.
682686
* </pre>
683687
*

proto-google-common-protos/src/main/java/com/google/type/DateOrBuilder.java

+4-4
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ public interface DateOrBuilder
2727
*
2828
*
2929
* <pre>
30-
* Year of date. Must be from 1 to 9999, or 0 if specifying a date without
30+
* Year of the date. Must be from 1 to 9999, or 0 to specify a date without
3131
* a year.
3232
* </pre>
3333
*
@@ -41,7 +41,7 @@ public interface DateOrBuilder
4141
*
4242
*
4343
* <pre>
44-
* Month of year. Must be from 1 to 12, or 0 if specifying a year without a
44+
* Month of a year. Must be from 1 to 12, or 0 to specify a year without a
4545
* month and day.
4646
* </pre>
4747
*
@@ -55,8 +55,8 @@ public interface DateOrBuilder
5555
*
5656
*
5757
* <pre>
58-
* Day of month. Must be from 1 to 31 and valid for the year and month, or 0
59-
* if specifying a year by itself or a year and month where the day is not
58+
* Day of a month. Must be from 1 to 31 and valid for the year and month, or 0
59+
* to specify a year by itself or a year and month where the day isn't
6060
* significant.
6161
* </pre>
6262
*

proto-google-common-protos/src/main/java/com/google/type/DayOfWeek.java

+17-17
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@
2222
*
2323
*
2424
* <pre>
25-
* Represents a day of week.
25+
* Represents a day of the week.
2626
* </pre>
2727
*
2828
* Protobuf enum {@code google.type.DayOfWeek}
@@ -32,7 +32,7 @@ public enum DayOfWeek implements com.google.protobuf.ProtocolMessageEnum {
3232
*
3333
*
3434
* <pre>
35-
* The unspecified day-of-week.
35+
* The day of the week is unspecified.
3636
* </pre>
3737
*
3838
* <code>DAY_OF_WEEK_UNSPECIFIED = 0;</code>
@@ -42,7 +42,7 @@ public enum DayOfWeek implements com.google.protobuf.ProtocolMessageEnum {
4242
*
4343
*
4444
* <pre>
45-
* The day-of-week of Monday.
45+
* Monday
4646
* </pre>
4747
*
4848
* <code>MONDAY = 1;</code>
@@ -52,7 +52,7 @@ public enum DayOfWeek implements com.google.protobuf.ProtocolMessageEnum {
5252
*
5353
*
5454
* <pre>
55-
* The day-of-week of Tuesday.
55+
* Tuesday
5656
* </pre>
5757
*
5858
* <code>TUESDAY = 2;</code>
@@ -62,7 +62,7 @@ public enum DayOfWeek implements com.google.protobuf.ProtocolMessageEnum {
6262
*
6363
*
6464
* <pre>
65-
* The day-of-week of Wednesday.
65+
* Wednesday
6666
* </pre>
6767
*
6868
* <code>WEDNESDAY = 3;</code>
@@ -72,7 +72,7 @@ public enum DayOfWeek implements com.google.protobuf.ProtocolMessageEnum {
7272
*
7373
*
7474
* <pre>
75-
* The day-of-week of Thursday.
75+
* Thursday
7676
* </pre>
7777
*
7878
* <code>THURSDAY = 4;</code>
@@ -82,7 +82,7 @@ public enum DayOfWeek implements com.google.protobuf.ProtocolMessageEnum {
8282
*
8383
*
8484
* <pre>
85-
* The day-of-week of Friday.
85+
* Friday
8686
* </pre>
8787
*
8888
* <code>FRIDAY = 5;</code>
@@ -92,7 +92,7 @@ public enum DayOfWeek implements com.google.protobuf.ProtocolMessageEnum {
9292
*
9393
*
9494
* <pre>
95-
* The day-of-week of Saturday.
95+
* Saturday
9696
* </pre>
9797
*
9898
* <code>SATURDAY = 6;</code>
@@ -102,7 +102,7 @@ public enum DayOfWeek implements com.google.protobuf.ProtocolMessageEnum {
102102
*
103103
*
104104
* <pre>
105-
* The day-of-week of Sunday.
105+
* Sunday
106106
* </pre>
107107
*
108108
* <code>SUNDAY = 7;</code>
@@ -115,7 +115,7 @@ public enum DayOfWeek implements com.google.protobuf.ProtocolMessageEnum {
115115
*
116116
*
117117
* <pre>
118-
* The unspecified day-of-week.
118+
* The day of the week is unspecified.
119119
* </pre>
120120
*
121121
* <code>DAY_OF_WEEK_UNSPECIFIED = 0;</code>
@@ -125,7 +125,7 @@ public enum DayOfWeek implements com.google.protobuf.ProtocolMessageEnum {
125125
*
126126
*
127127
* <pre>
128-
* The day-of-week of Monday.
128+
* Monday
129129
* </pre>
130130
*
131131
* <code>MONDAY = 1;</code>
@@ -135,7 +135,7 @@ public enum DayOfWeek implements com.google.protobuf.ProtocolMessageEnum {
135135
*
136136
*
137137
* <pre>
138-
* The day-of-week of Tuesday.
138+
* Tuesday
139139
* </pre>
140140
*
141141
* <code>TUESDAY = 2;</code>
@@ -145,7 +145,7 @@ public enum DayOfWeek implements com.google.protobuf.ProtocolMessageEnum {
145145
*
146146
*
147147
* <pre>
148-
* The day-of-week of Wednesday.
148+
* Wednesday
149149
* </pre>
150150
*
151151
* <code>WEDNESDAY = 3;</code>
@@ -155,7 +155,7 @@ public enum DayOfWeek implements com.google.protobuf.ProtocolMessageEnum {
155155
*
156156
*
157157
* <pre>
158-
* The day-of-week of Thursday.
158+
* Thursday
159159
* </pre>
160160
*
161161
* <code>THURSDAY = 4;</code>
@@ -165,7 +165,7 @@ public enum DayOfWeek implements com.google.protobuf.ProtocolMessageEnum {
165165
*
166166
*
167167
* <pre>
168-
* The day-of-week of Friday.
168+
* Friday
169169
* </pre>
170170
*
171171
* <code>FRIDAY = 5;</code>
@@ -175,7 +175,7 @@ public enum DayOfWeek implements com.google.protobuf.ProtocolMessageEnum {
175175
*
176176
*
177177
* <pre>
178-
* The day-of-week of Saturday.
178+
* Saturday
179179
* </pre>
180180
*
181181
* <code>SATURDAY = 6;</code>
@@ -185,7 +185,7 @@ public enum DayOfWeek implements com.google.protobuf.ProtocolMessageEnum {
185185
*
186186
*
187187
* <pre>
188-
* The day-of-week of Sunday.
188+
* Sunday
189189
* </pre>
190190
*
191191
* <code>SUNDAY = 7;</code>

0 commit comments

Comments
 (0)