jsdoc

pgayvallet · pgayvallet · commit 3bda52eb6ff5 · 2020-04-16T08:49:21.000+02:00
diff --git a/x-pack/plugins/licensing/server/services/feature_usage_service.ts b/x-pack/plugins/licensing/server/services/feature_usage_service.ts
@@ -4,12 +4,29 @@
  * you may not use this file except in compliance with the Elastic License.
  */
 
+/** @public */
 export interface FeatureUsageServiceSetup {
+  /**
+   * Register a feature to be able to notify of it's usages using the {@link FeatureUsageServiceStart | service start contract}.
+   */
   register(featureName: string): void;
 }
+
+/** @public */
 export interface FeatureUsageServiceStart {
+  /**
+   * Notify of a registered feature usage at given time.
+   * If `usedAt` is not specified, it will use the current time instead.
+   */
   notifyUsage(featureName: string, usedAt?: number): void;
+  /**
+   * Return a map containing last usage timestamp for all features.
+   * Features that were not used yet do not appear in the map.
+   */
   getLastUsages(): ReadonlyMap<string, number>;
+  /**
+   * Clear all usage records from the service.
+   */
   clear(): void;
 }
 
diff --git a/x-pack/plugins/licensing/server/types.ts b/x-pack/plugins/licensing/server/types.ts
@@ -58,7 +58,6 @@ export interface LicensingPluginSetup {
    * Triggers licensing information re-fetch.
    */
   refresh(): Promise<ILicense>;
-
   /**
    * Creates a license poller to retrieve a license data with.
    * Allows a plugin to configure a cluster to retrieve data from at
@@ -68,17 +67,16 @@ export interface LicensingPluginSetup {
     clusterClient: IClusterClient,
     pollingFrequency: number
   ) => { license$: Observable<ILicense>; refresh(): Promise<ILicense> };
-
   /**
-   * TODO
+   * APIs to register licensed feature usage.
    */
   featureUsage: FeatureUsageServiceSetup;
 }
 
 /** @public */
 export interface LicensingPluginStart {
   /**
-   * TODO
+   * APIs to manage licensed feature usage.
    */
   featureUsage: FeatureUsageServiceStart;
 }
