[api-extractor] Add support for "@defaultvalue"

apps/api-extractor/src/aedoc/ApiDocumentation.ts

@@ -48,6 +48,7 @@ export class ApiDocumentation {
     '@alpha',
     '@beta',
     '@betadocumentation',
+    '@defaultvalue',
     '@eventproperty',
     '@internal',
     '@internalremarks',
@@ -340,6 +341,12 @@ export class ApiDocumentation {
             tokenizer.getToken();
             this.isOverride = true;
             break;
+          case '@defaultvalue':
+            // Accept this for now, but don't process it.
+            // We'll implement it fully when the TSDoc engine is merged.
+            tokenizer.getToken();
+            DocElementParser.parse(this, tokenizer);
+            break;
           default:
             tokenizer.getToken();
             this._reportBadAedocTag(token);

build-tests/api-extractor-test-05/src/DocClass1.ts

@@ -16,6 +16,7 @@ export class SystemEvent {
  *
  * @remarks
  * These are some remarks.
+ * @defaultvalue a default value for this function
  * @public
  */
 export class DocClass1 {

common/changes/@microsoft/api-extractor/pgonzal-ae-default-tag_2018-09-21-05-33.json

@@ -0,0 +1,11 @@
+{
+  "changes": [
+    {
+      "packageName": "@microsoft/api-extractor",
+      "comment": "Allow doc comments to use TSDoc's \"@defaultvalue\" tag (but the value is not yet passed to the documentation pipeline)",
+      "type": "patch"
+    }
+  ],
+  "packageName": "@microsoft/api-extractor",
+  "email": "[email protected]"
+}