Add comments for getMetric() method

census-instrumentation · Apr 11, 2019 · 6444d01 · 6444d01
1 parent e8c2965
commit 6444d01
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 2 deletions.
diff --git a/packages/opencensus-core/src/metrics/cumulative/cumulative.ts b/packages/opencensus-core/src/metrics/cumulative/cumulative.ts
@@ -131,7 +131,8 @@ export class Cumulative implements Meter {
   /**
    * Provides a Metric with one or more TimeSeries.
    *
-   * @returns {Metric} The Metric.
+   * @returns {Metric} The Metric, or null if TimeSeries is not present in
+   *     Metric.
    */
   getMetric(): Metric|null {
     if (this.registeredPoints.size === 0) {

diff --git a/packages/opencensus-core/src/metrics/types.ts b/packages/opencensus-core/src/metrics/types.ts
@@ -17,11 +17,13 @@
 import {MeasureUnit} from './../stats/types';
 import {LabelKey, LabelValue, Metric} from './export/types';
 
+/** Provides a {@link Metric} with one or more {@link TimeSeries} */
 export interface Meter {
   /**
    * Provides a Metric with one or more TimeSeries.
    *
-   * @returns {Metric} The Metric.
+   * @returns {Metric} The Metric, or null if TimeSeries is not present in
+   *     Metric.
    */
   getMetric(): Metric|null;
 }