Convert packageDescription syntax to @packagedocumentation syntax

pgonzal · pgonzal · commit 7fc5938bc3a5 · 2018-01-08T15:43:14.000-08:00
diff --git a/apps/api-extractor/src/index.ts b/apps/api-extractor/src/index.ts
@@ -5,8 +5,9 @@
  * API Extractor helps you build better TypeScript library packages.
  * It helps with validation, documentation, and reviewing of the exported API
  * for a TypeScript library.
+ *
+ * @packagedocumentation
  */
-declare const packageDescription: void; // tslint:disable-line:no-unused-variable
 
 export { default as ExternalApiHelper } from './ExternalApiHelper';
 
diff --git a/apps/api-extractor/testInputs/example2/src/index.ts b/apps/api-extractor/testInputs/example2/src/index.ts
@@ -3,10 +3,13 @@
 
 /**
  * Here is some documentation for example2.
- * @remarks These are additional remarks that may be too long for the summary.
+ *
+ * @remarks
+ * These are additional remarks that may be too long for the summary.
  * They should appear in the remarks of the json generated file for this package.
+ *
+ * @packagedocumentation
  */
-declare const packageDescription: void;
 
 export {
     TestMissingCommentStar,
diff --git a/apps/api-extractor/testInputs/example3/src/index.ts b/apps/api-extractor/testInputs/example3/src/index.ts
@@ -3,8 +3,9 @@
 
 /**
  * This example folder is used to test the functionality of DocItemLoader and API reference resolution.
+ *
+ * @packagedocumentation
  */
-declare const packageDescription: void;
 
 export {
     inheritLocalOptionOne,
diff --git a/libraries/node-core-library/src/index.ts b/libraries/node-core-library/src/index.ts
@@ -3,8 +3,9 @@
 
 /**
  * Core libraries that every NodeJS toolchain project should use.
+ *
+ * @packagedocumentation
  */
-declare const packageDescription: void; // tslint:disable-line:no-unused-variable
 
 export { FileDiffTest } from './FileDiffTest';
 export {
diff --git a/libraries/ts-command-line/src/index.ts b/libraries/ts-command-line/src/index.ts
@@ -3,8 +3,9 @@
 
 /**
  * An object-oriented command-line parser for TypeScript projects.
+ *
+ * @packagedocumentation
  */
-declare const packageDescription: void; // tslint:disable-line:no-unused-variable
 
 export {
   default as CommandLineAction,
