Affixing examples to a full section instead of making a blank remarks

AlexJerabek · AlexJerabek · commit 657d416bfa18 · 2018-07-18T14:37:02.000-07:00
diff --git a/apps/api-documenter/src/yaml/OfficeYamlDocumenter.ts b/apps/api-documenter/src/yaml/OfficeYamlDocumenter.ts
@@ -92,17 +92,16 @@ export class OfficeYamlDocumenter extends YamlDocumenter {
     if (snippets) {
       delete this._snippets[nameWithoutPackage];
 
-      if (!yamlItem.remarks) {
-        yamlItem.remarks = '';
-      }
-
-      yamlItem.remarks += '\n\n#### Examples\n';
-      for (const snippet of snippets) {
-        if (snippet.search(/await/) === -1) {
-          yamlItem.remarks += '\n```javascript\n' + snippet + '\n```\n';
-        } else {
-          yamlItem.remarks += '\n```typescript\n' + snippet + '\n```\n';
+      if (yamlItem.remarks) {
+        yamlItem.remarks += this._generateSnippetText(snippets);
+      } else if (yamlItem.syntax && yamlItem.syntax.return) {
+        if (!yamlItem.syntax.return.description) {
+          yamlItem.syntax.return.description = '';
         }
+        yamlItem.syntax.return.description += this._generateSnippetText(snippets);
+      }else {
+        yamlItem.remarks = '';
+        yamlItem.remarks += this._generateSnippetText(snippets);
       }
     }
   }
@@ -148,4 +147,16 @@ export class OfficeYamlDocumenter extends YamlDocumenter {
     }
     return text;
   }
+
+  private _generateSnippetText(snippets: string[]): string {
+    let text: string = '\n\n#### Examples\n';
+    for (const snippet of snippets) {
+      if (snippet.search(/await/) === -1) {
+        text += '\n```javascript\n' + snippet + '\n```\n';
+      } else {
+        text += '\n```typescript\n' + snippet + '\n```\n';
+      }
+    }
+    return text;
+  }
 }
