docs: update jsdoc formatting (#480)

googleapis · May 11, 2019 · c732969 · c732969
1 parent 558bfc5
commit c732969
Show file tree

Hide file tree

Showing 3 changed files with 14 additions and 3 deletions.
diff --git a/src/v2/doc/google/api/doc_metric.js b/src/v2/doc/google/api/doc_metric.js
@@ -136,6 +136,11 @@
  *
  *   This object should have the same structure as [MetricDescriptorMetadata]{@link google.api.MetricDescriptorMetadata}
  *
+ * @property {number} launchStage
+ *   Optional. The launch stage of the metric definition.
+ *
+ *   The number should be among the values of [LaunchStage]{@link google.api.LaunchStage}
+ *
  * @typedef MetricDescriptor
  * @memberof google.api
  * @see [google.api.MetricDescriptor definition in proto format]{@link https://github.com/googleapis/googleapis/blob/master/google/api/metric.proto}
@@ -147,6 +152,7 @@ const MetricDescriptor = {
    * Additional annotations that can be used to guide the usage of a metric.
    *
    * @property {number} launchStage
+   *   Deprecated. Please use the MetricDescriptor.launch_stage instead.
    *   The launch stage of the metric definition.
    *
    *   The number should be among the values of [LaunchStage]{@link google.api.LaunchStage}

diff --git a/src/v2/doc/google/api/doc_monitored_resource.js b/src/v2/doc/google/api/doc_monitored_resource.js
@@ -56,6 +56,11 @@
  *
  *   This object should have the same structure as [LabelDescriptor]{@link google.api.LabelDescriptor}
  *
+ * @property {number} launchStage
+ *   Optional. The launch stage of the monitored resource definition.
+ *
+ *   The number should be among the values of [LaunchStage]{@link google.api.LaunchStage}
+ *
  * @typedef MonitoredResourceDescriptor
  * @memberof google.api
  * @see [google.api.MonitoredResourceDescriptor definition in proto format]{@link https://github.com/googleapis/googleapis/blob/master/google/api/monitored_resource.proto}

diff --git a/synth.metadata b/synth.metadata
@@ -1,5 +1,5 @@
 {
-  "updateTime": "2019-05-10T12:07:43.126546Z",
+  "updateTime": "2019-05-11T11:17:55.714678Z",
   "sources": [
     {
       "generator": {
@@ -12,8 +12,8 @@
       "git": {
         "name": "googleapis",
         "remote": "https://github.com/googleapis/googleapis.git",
-        "sha": "07883be5bf3c3233095e99d8e92b8094f5d7084a",
-        "internalRef": "247530843"
+        "sha": "32b08107fa1710f46287c17d5bb2016e443ed3ba",
+        "internalRef": "247684466"
       }
     },
     {