Add some missing docs

octogonz · octogonz · commit 95bf55b914ce · 2019-09-05T21:05:47.000-07:00
diff --git a/apps/api-documenter/src/plugin/MarkdownDocumenterFeature.ts b/apps/api-documenter/src/plugin/MarkdownDocumenterFeature.ts
@@ -7,6 +7,7 @@ import { MarkdownDocumenterAccessor } from './MarkdownDocumenterAccessor';
 
 /**
  * Context object for {@link MarkdownDocumenterFeature}.
+ * Exposes various services that can be used by a plugin.
  *
  * @public
  */
@@ -45,7 +46,8 @@ export interface IMarkdownDocumenterFeatureOnBeforeWritePageArgs {
   readonly apiItem: ApiItem;
 
   /**
-   * The page content.  The onBeforeWritePage() handler can reassign this string to customize the page appearance.
+   * The page content.  The {@link MarkdownDocumenterFeature.onBeforeWritePage} handler can reassign this
+   * string to customize the page appearance.
    */
   pageContent: string;
 
@@ -69,6 +71,7 @@ export interface IMarkdownDocumenterFeatureOnFinishedArgs {
  * @public
  */
 export class MarkdownDocumenterFeature extends PluginFeature {
+  /** {@inheritdoc PluginFeature.context} */
   public context: MarkdownDocumenterFeatureContext;
 
   /**
diff --git a/apps/api-documenter/src/plugin/PluginFeature.ts b/apps/api-documenter/src/plugin/PluginFeature.ts
@@ -21,6 +21,7 @@ export class PluginFeatureInitialization {
 
 /**
  * Context object for {@link PluginFeature}.
+ * Exposes various services that can be used by a plugin.
  *
  * @public
  */
@@ -32,11 +33,14 @@ export class PluginFeatureContext {
  * @public
  */
 export abstract class PluginFeature {
+  /**
+   * Exposes various services that can be used by a plugin.
+   */
   public context: PluginFeatureContext;
 
   /**
    * The subclass should pass the `initialization` through to the base class.
-   * Do not put custom initialization code in the constructor.  Insteadm perform your initialization in the
+   * Do not put custom initialization code in the constructor.  Instead perform your initialization in the
    * `onInitialized()` event function.
    * @internal
    */
diff --git a/common/reviews/api/api-documenter.api.md b/common/reviews/api/api-documenter.api.md
@@ -44,7 +44,6 @@ export class MarkdownDocumenterAccessor {
 
 // @public
 export class MarkdownDocumenterFeature extends PluginFeature {
-    // (undocumented)
     context: MarkdownDocumenterFeatureContext;
     // @virtual
     onBeforeWritePage(eventArgs: IMarkdownDocumenterFeatureOnBeforeWritePageArgs): void;
@@ -65,7 +64,6 @@ export class MarkdownDocumenterFeatureContext {
 export abstract class PluginFeature {
     // @internal
     constructor(initialization: PluginFeatureInitialization);
-    // (undocumented)
     context: PluginFeatureContext;
     // @virtual
     onInitialized(): void;
