[ADF- 3846] Started Extensions library docs (#4095)

* [ADF-3846] Added some doc comments and skeleton doc files

* [ADF-3846] Added basic docs for Extensions library

* [ADF-3846] Fixes to index pages

* [ADF-3846] Did tslint check and fixed error with doc comment
This commit is contained in:
Andy Stark
2018-12-21 17:46:03 +00:00
committed by Eugenio Romano
parent b604b2a4b7
commit 478b299960
13 changed files with 541 additions and 52 deletions

View File

@@ -65,6 +65,7 @@
"datatable-adapter.interface": "DataTableAdapter",
"datatable.component": "DataTableComponent",
"document-library.model": "NodePaging",
"dynamic.component": "DynamicExtensionComponent",
"form-field-validator.interface": "FormFieldValidator",
"header.component": "HeaderLayoutComponent",
"inherited-button.directive": "InheritPermissionDirective",
@@ -82,6 +83,7 @@
},
"undocStoplist": [
"model",
"component-register.service",
"context-menu-holder",
"data-column-list",
"card-view-[a-z]+item",
@@ -90,6 +92,7 @@
"content-action-list",
"empty-folder-content",
"empty-list",
"extension-loader.service",
"loading-template",
"no-content-template",
"card-view-content-proxy",

View File

@@ -1,5 +1,5 @@
"use strict";
exports.__esModule = true;
Object.defineProperty(exports, "__esModule", { value: true });
var path = require("path");
var fs = require("fs");
/*
@@ -25,7 +25,7 @@ var includedNodeTypes = [
"link", "text"
];
var docFolder = path.resolve("docs");
var adfLibNames = ["core", "content-services", "insights", "process-services", "process-services-cloud"];
var adfLibNames = ["core", "content-services", "insights", "process-services", "process-services-cloud", "extensions"];
var externalNameLinks;
function processDocs(mdCache, aggData, errorMessages) {
initPhase(aggData);
@@ -99,8 +99,9 @@ function updateFile(tree, pathname, aggData, _errorMessages) {
}
}
}
else if ((node.children) && (node.type !== "heading")) {
else if ((node.children) && (node.type !== "heading")) { //((node.type === "paragraph") || (node.type === "tableCell")) {
node.children.forEach(function (child, index) {
var _a;
if ((child.type === "text") || (child.type === "inlineCode")) {
var newNodes = handleLinksInBodyText(aggData, child.value, child.type === 'inlineCode');
(_a = node.children).splice.apply(_a, [index, 1].concat(newNodes));
@@ -108,7 +109,6 @@ function updateFile(tree, pathname, aggData, _errorMessages) {
else {
traverseMDTree(child);
}
var _a;
});
} /*else if (node.children) {
node.children.forEach(child => {

View File

@@ -35,7 +35,7 @@ const includedNodeTypes = [
];
const docFolder = path.resolve("docs");
const adfLibNames = ["core", "content-services", "insights", "process-services", "process-services-cloud"];
const adfLibNames = ["core", "content-services", "insights", "process-services", "process-services-cloud", "extensions"];
let externalNameLinks;