microsoft · octogonz · Apr 9, 2019 · Apr 8, 2019 · Apr 8, 2019 · Apr 9, 2019
diff --git a/apps/api-documenter/src/documenters/MarkdownDocumenter.ts b/apps/api-documenter/src/documenters/MarkdownDocumenter.ts
@@ -234,6 +234,8 @@ export class MarkdownDocumenter {
  const filename: string = path.join(this._outputFolder, this._getFilenameForApiItem(apiItem));
  const stringBuilder: StringBuilder = new StringBuilder();
 
+ stringBuilder.append('<!-- Do not edit this file. It is automatically generated by API Documenter. -->\n\n');
+
  this._markdownEmitter.emit(stringBuilder, output, {
  contextApiItem: apiItem,
  onGetFilenameForApiItem: (apiItemForFilename: ApiItem) => {

diff --git a/build-tests/api-documenter-test/etc/markdown/api-documenter-test.constvariable.md b/build-tests/api-documenter-test/etc/markdown/api-documenter-test.constvariable.md
@@ -1,3 +1,5 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
 [Home](./index) &gt; [api-documenter-test](./api-documenter-test.md) &gt; [constVariable](./api-documenter-test.constvariable.md)
 
 ## constVariable variable

diff --git a/build-tests/api-documenter-test/etc/markdown/api-documenter-test.docbaseclass.md b/build-tests/api-documenter-test/etc/markdown/api-documenter-test.docbaseclass.md
@@ -1,3 +1,5 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
 [Home](./index) &gt; [api-documenter-test](./api-documenter-test.md) &gt; [DocBaseClass](./api-documenter-test.docbaseclass.md)
 
 ## DocBaseClass class

diff --git a/...documenter-test/etc/markdown/api-documenter-test.docclass1.deprecatedexample.md b/...documenter-test/etc/markdown/api-documenter-test.docclass1.deprecatedexample.md
@@ -1,3 +1,5 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
 [Home](./index) &gt; [api-documenter-test](./api-documenter-test.md) &gt; [DocClass1](./api-documenter-test.docclass1.md) &gt; [deprecatedExample](./api-documenter-test.docclass1.deprecatedexample.md)
 
 ## DocClass1.deprecatedExample() method

diff --git a/...i-documenter-test/etc/markdown/api-documenter-test.docclass1.examplefunction.md b/...i-documenter-test/etc/markdown/api-documenter-test.docclass1.examplefunction.md
@@ -1,3 +1,5 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
 [Home](./index) &gt; [api-documenter-test](./api-documenter-test.md) &gt; [DocClass1](./api-documenter-test.docclass1.md) &gt; [exampleFunction](./api-documenter-test.docclass1.examplefunction.md)
 
 ## DocClass1.exampleFunction() method

diff --git a/...documenter-test/etc/markdown/api-documenter-test.docclass1.examplefunction_1.md b/...documenter-test/etc/markdown/api-documenter-test.docclass1.examplefunction_1.md
@@ -1,3 +1,5 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
 [Home](./index) &gt; [api-documenter-test](./api-documenter-test.md) &gt; [DocClass1](./api-documenter-test.docclass1.md) &gt; [exampleFunction](./api-documenter-test.docclass1.examplefunction_1.md)
 
 ## DocClass1.exampleFunction() method

diff --git a/...umenter-test/etc/markdown/api-documenter-test.docclass1.interestingedgecases.md b/...umenter-test/etc/markdown/api-documenter-test.docclass1.interestingedgecases.md
@@ -1,3 +1,5 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
 [Home](./index) &gt; [api-documenter-test](./api-documenter-test.md) &gt; [DocClass1](./api-documenter-test.docclass1.md) &gt; [interestingEdgeCases](./api-documenter-test.docclass1.interestingedgecases.md)
 
 ## DocClass1.interestingEdgeCases() method

diff --git a/...pi-documenter-test/etc/markdown/api-documenter-test.docclass1.malformedevent.md b/...pi-documenter-test/etc/markdown/api-documenter-test.docclass1.malformedevent.md
@@ -1,3 +1,5 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
 [Home](./index) &gt; [api-documenter-test](./api-documenter-test.md) &gt; [DocClass1](./api-documenter-test.docclass1.md) &gt; [malformedEvent](./api-documenter-test.docclass1.malformedevent.md)
 
 ## DocClass1.malformedEvent property

diff --git a/build-tests/api-documenter-test/etc/markdown/api-documenter-test.docclass1.md b/build-tests/api-documenter-test/etc/markdown/api-documenter-test.docclass1.md
@@ -1,3 +1,5 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
 [Home](./index) &gt; [api-documenter-test](./api-documenter-test.md) &gt; [DocClass1](./api-documenter-test.docclass1.md)
 
 ## DocClass1 class

diff --git a/...api-documenter-test/etc/markdown/api-documenter-test.docclass1.modifiedevent.md b/...api-documenter-test/etc/markdown/api-documenter-test.docclass1.modifiedevent.md
@@ -1,3 +1,5 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
 [Home](./index) &gt; [api-documenter-test](./api-documenter-test.md) &gt; [DocClass1](./api-documenter-test.docclass1.md) &gt; [modifiedEvent](./api-documenter-test.docclass1.modifiedevent.md)
 
 ## DocClass1.modifiedEvent property

diff --git a/...i-documenter-test/etc/markdown/api-documenter-test.docclass1.regularproperty.md b/...i-documenter-test/etc/markdown/api-documenter-test.docclass1.regularproperty.md
@@ -1,3 +1,5 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
 [Home](./index) &gt; [api-documenter-test](./api-documenter-test.md) &gt; [DocClass1](./api-documenter-test.docclass1.md) &gt; [regularProperty](./api-documenter-test.docclass1.regularproperty.md)
 
 ## DocClass1.regularProperty property

diff --git a/...pi-documenter-test/etc/markdown/api-documenter-test.docclass1.sumwithexample.md b/...pi-documenter-test/etc/markdown/api-documenter-test.docclass1.sumwithexample.md
@@ -1,3 +1,5 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
 [Home](./index) &gt; [api-documenter-test](./api-documenter-test.md) &gt; [DocClass1](./api-documenter-test.docclass1.md) &gt; [sumWithExample](./api-documenter-test.docclass1.sumwithexample.md)
 
 ## DocClass1.sumWithExample() method

diff --git a/.../api-documenter-test/etc/markdown/api-documenter-test.docclass1.tableexample.md b/.../api-documenter-test/etc/markdown/api-documenter-test.docclass1.tableexample.md
@@ -1,3 +1,5 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
 [Home](./index) &gt; [api-documenter-test](./api-documenter-test.md) &gt; [DocClass1](./api-documenter-test.docclass1.md) &gt; [tableExample](./api-documenter-test.docclass1.tableexample.md)
 
 ## DocClass1.tableExample() method

diff --git a/build-tests/api-documenter-test/etc/markdown/api-documenter-test.docenum.md b/build-tests/api-documenter-test/etc/markdown/api-documenter-test.docenum.md
@@ -1,3 +1,5 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
 [Home](./index) &gt; [api-documenter-test](./api-documenter-test.md) &gt; [DocEnum](./api-documenter-test.docenum.md)
 
 ## DocEnum enum

diff --git a/...-tests/api-documenter-test/etc/markdown/api-documenter-test.exampletypealias.md b/...-tests/api-documenter-test/etc/markdown/api-documenter-test.exampletypealias.md
@@ -1,3 +1,5 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
 [Home](./index) &gt; [api-documenter-test](./api-documenter-test.md) &gt; [ExampleTypeAlias](./api-documenter-test.exampletypealias.md)
 
 ## ExampleTypeAlias type

diff --git a/build-tests/api-documenter-test/etc/markdown/api-documenter-test.generic.md b/build-tests/api-documenter-test/etc/markdown/api-documenter-test.generic.md
@@ -1,3 +1,5 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
 [Home](./index) &gt; [api-documenter-test](./api-documenter-test.md) &gt; [Generic](./api-documenter-test.generic.md)
 
 ## Generic class

diff --git a/build-tests/api-documenter-test/etc/markdown/api-documenter-test.globalfunction.md b/build-tests/api-documenter-test/etc/markdown/api-documenter-test.globalfunction.md
@@ -1,3 +1,5 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
 [Home](./index) &gt; [api-documenter-test](./api-documenter-test.md) &gt; [globalFunction](./api-documenter-test.globalfunction.md)
 
 ## globalFunction() function

diff --git a/build-tests/api-documenter-test/etc/markdown/api-documenter-test.idocinterface1.md b/build-tests/api-documenter-test/etc/markdown/api-documenter-test.idocinterface1.md
@@ -1,3 +1,5 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
 [Home](./index) &gt; [api-documenter-test](./api-documenter-test.md) &gt; [IDocInterface1](./api-documenter-test.idocinterface1.md)
 
 ## IDocInterface1 interface

diff --git a/...umenter-test/etc/markdown/api-documenter-test.idocinterface1.regularproperty.md b/...umenter-test/etc/markdown/api-documenter-test.idocinterface1.regularproperty.md
@@ -1,3 +1,5 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
 [Home](./index) &gt; [api-documenter-test](./api-documenter-test.md) &gt; [IDocInterface1](./api-documenter-test.idocinterface1.md) &gt; [regularProperty](./api-documenter-test.idocinterface1.regularproperty.md)
 
 ## IDocInterface1.regularProperty property

diff --git a/...enter-test/etc/markdown/api-documenter-test.idocinterface2.deprecatedexample.md b/...enter-test/etc/markdown/api-documenter-test.idocinterface2.deprecatedexample.md
@@ -1,3 +1,5 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
 [Home](./index) &gt; [api-documenter-test](./api-documenter-test.md) &gt; [IDocInterface2](./api-documenter-test.idocinterface2.md) &gt; [deprecatedExample](./api-documenter-test.idocinterface2.deprecatedexample.md)
 
 ## IDocInterface2.deprecatedExample() method

diff --git a/build-tests/api-documenter-test/etc/markdown/api-documenter-test.idocinterface2.md b/build-tests/api-documenter-test/etc/markdown/api-documenter-test.idocinterface2.md
@@ -1,3 +1,5 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
 [Home](./index) &gt; [api-documenter-test](./api-documenter-test.md) &gt; [IDocInterface2](./api-documenter-test.idocinterface2.md)
 
 ## IDocInterface2 interface

diff --git a/build-tests/api-documenter-test/etc/markdown/api-documenter-test.idocinterface3.md b/build-tests/api-documenter-test/etc/markdown/api-documenter-test.idocinterface3.md
@@ -1,3 +1,5 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
 [Home](./index) &gt; [api-documenter-test](./api-documenter-test.md) &gt; [IDocInterface3](./api-documenter-test.idocinterface3.md)
 
 ## IDocInterface3 interface

diff --git a/.../api-documenter-test/etc/markdown/api-documenter-test.idocinterface4.generic.md b/.../api-documenter-test/etc/markdown/api-documenter-test.idocinterface4.generic.md
@@ -1,3 +1,5 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
 [Home](./index) &gt; [api-documenter-test](./api-documenter-test.md) &gt; [IDocInterface4](./api-documenter-test.idocinterface4.md) &gt; [generic](./api-documenter-test.idocinterface4.generic.md)
 
 ## IDocInterface4.generic property

diff --git a/build-tests/api-documenter-test/etc/markdown/api-documenter-test.idocinterface4.md b/build-tests/api-documenter-test/etc/markdown/api-documenter-test.idocinterface4.md
@@ -1,3 +1,5 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
 [Home](./index) &gt; [api-documenter-test](./api-documenter-test.md) &gt; [IDocInterface4](./api-documenter-test.idocinterface4.md)
 
 ## IDocInterface4 interface

diff --git a/...menter-test/etc/markdown/api-documenter-test.idocinterface4.numberorfunction.md b/...menter-test/etc/markdown/api-documenter-test.idocinterface4.numberorfunction.md
@@ -1,3 +1,5 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
 [Home](./index) &gt; [api-documenter-test](./api-documenter-test.md) &gt; [IDocInterface4](./api-documenter-test.idocinterface4.md) &gt; [numberOrFunction](./api-documenter-test.idocinterface4.numberorfunction.md)
 
 ## IDocInterface4.numberOrFunction property

diff --git a/...cumenter-test/etc/markdown/api-documenter-test.idocinterface4.stringornumber.md b/...cumenter-test/etc/markdown/api-documenter-test.idocinterface4.stringornumber.md
@@ -1,3 +1,5 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
 [Home](./index) &gt; [api-documenter-test](./api-documenter-test.md) &gt; [IDocInterface4](./api-documenter-test.idocinterface4.md) &gt; [stringOrNumber](./api-documenter-test.idocinterface4.stringornumber.md)
 
 ## IDocInterface4.stringOrNumber property

diff --git a/build-tests/api-documenter-test/etc/markdown/api-documenter-test.md b/build-tests/api-documenter-test/etc/markdown/api-documenter-test.md
@@ -1,3 +1,5 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
 [Home](./index) &gt; [api-documenter-test](./api-documenter-test.md)
 
 ## api-documenter-test package

diff --git a/...cumenter-test/etc/markdown/api-documenter-test.outernamespace.innernamespace.md b/...cumenter-test/etc/markdown/api-documenter-test.outernamespace.innernamespace.md
@@ -1,3 +1,5 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
 [Home](./index) &gt; [api-documenter-test](./api-documenter-test.md) &gt; [OuterNamespace](./api-documenter-test.outernamespace.md) &gt; [InnerNamespace](./api-documenter-test.outernamespace.innernamespace.md)
 
 ## OuterNamespace.InnerNamespace namespace

diff --git a/...tc/markdown/api-documenter-test.outernamespace.innernamespace.nestedfunction.md b/...tc/markdown/api-documenter-test.outernamespace.innernamespace.nestedfunction.md
@@ -1,3 +1,5 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
 [Home](./index) &gt; [api-documenter-test](./api-documenter-test.md) &gt; [OuterNamespace](./api-documenter-test.outernamespace.md) &gt; [InnerNamespace](./api-documenter-test.outernamespace.innernamespace.md) &gt; [nestedFunction](./api-documenter-test.outernamespace.innernamespace.nestedfunction.md)
 
 ## OuterNamespace.InnerNamespace.nestedFunction() function

diff --git a/build-tests/api-documenter-test/etc/markdown/api-documenter-test.outernamespace.md b/build-tests/api-documenter-test/etc/markdown/api-documenter-test.outernamespace.md
@@ -1,3 +1,5 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
 [Home](./index) &gt; [api-documenter-test](./api-documenter-test.md) &gt; [OuterNamespace](./api-documenter-test.outernamespace.md)
 
 ## OuterNamespace namespace

diff --git a/...cumenter-test/etc/markdown/api-documenter-test.outernamespace.nestedvariable.md b/...cumenter-test/etc/markdown/api-documenter-test.outernamespace.nestedvariable.md
@@ -1,3 +1,5 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
 [Home](./index) &gt; [api-documenter-test](./api-documenter-test.md) &gt; [OuterNamespace](./api-documenter-test.outernamespace.md) &gt; [nestedVariable](./api-documenter-test.outernamespace.nestedvariable.md)
 
 ## OuterNamespace.nestedVariable variable

diff --git a/.../api-documenter-test/etc/markdown/api-documenter-test.systemevent.addhandler.md b/.../api-documenter-test/etc/markdown/api-documenter-test.systemevent.addhandler.md
@@ -1,3 +1,5 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
 [Home](./index) &gt; [api-documenter-test](./api-documenter-test.md) &gt; [SystemEvent](./api-documenter-test.systemevent.md) &gt; [addHandler](./api-documenter-test.systemevent.addhandler.md)
 
 ## SystemEvent.addHandler() method

diff --git a/build-tests/api-documenter-test/etc/markdown/api-documenter-test.systemevent.md b/build-tests/api-documenter-test/etc/markdown/api-documenter-test.systemevent.md
@@ -1,3 +1,5 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
 [Home](./index) &gt; [api-documenter-test](./api-documenter-test.md) &gt; [SystemEvent](./api-documenter-test.systemevent.md)
 
 ## SystemEvent class

diff --git a/common/changes/@microsoft/api-documenter/ad-do-not-edit-comment_2019-04-08-12-40.json b/common/changes/@microsoft/api-documenter/ad-do-not-edit-comment_2019-04-08-12-40.json
@@ -0,0 +1,11 @@
+{
+ "changes": [
+ {
+ "packageName": "@microsoft/api-documenter",
+ "comment": "Add 'do not edit' header to generated documentation files",
+ "type": "patch"
+ }
+ ],
+ "packageName": "@microsoft/api-documenter",
+ "email": "[email protected]"
+}