inteligr8/alfresco-ng2-components
1
0
Fork 0
mirror of https://github.com/Alfresco/alfresco-ng2-components.git synced 2025-07-24 17:32:15 +00:00
Code Issues Packages Projects Releases Wiki Activity

Review Documentation and tools doc (#5600)

Browse Source 
* add exclude files property

* remove Unknown

* fix reviewer

* Update reviewChecker.js

* Update docs/README.md

Co-Authored-By: Mark Hulbert <39801222+m-hulbert@users.noreply.github.com>

Co-authored-by: Mark Hulbert <39801222+m-hulbert@users.noreply.github.com>
This commit is contained in:
Eugenio Romano
2020-04-09 11:55:33 +01:00
committed by GitHub
parent 8962ce0419
commit ecca9220f1
42 changed files with 265 additions and 195 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
tools/doc/tools/fileChecker.js
View File

@@ -11,7 +11,7 @@ var imageFolderPath = path.resolve('docs', 'docassets', 'images');
// and filenames is enough to trap errors like missing out the 'images'
// folder in the path. Keeping it low avoids crazy suggestions.
var maxImagePathLevDistance = 7;
function processDocs(mdCache, aggData, errorMessages) {
function processDocs(mdCache, aggData) {
var pathnames = Object.keys(mdCache);
var classlessDocs = [];
var linkRefs = {};

2
tools/doc/tools/fileChecker.ts
View File

@@ -13,7 +13,7 @@ const imageFolderPath = path.resolve('docs', 'docassets', 'images');
// folder in the path. Keeping it low avoids crazy suggestions.
const maxImagePathLevDistance = 7;
export function processDocs(mdCache, aggData, errorMessages) {
export function processDocs(mdCache, aggData) {
const pathnames = Object.keys(mdCache);
const classlessDocs = [];

2
tools/doc/tools/linkFixer.js
View File

@@ -5,7 +5,7 @@ var path = require("path");
var fs = require("fs");
var unist_util_select_1 = require("unist-util-select");
var suffixesNotToCheck = /\.ts/;
function processDocs(mdCache, aggData, errorMessages) {
function processDocs(mdCache, aggData) {
var pathnames = Object.keys(mdCache);
var linkSet = new LinkSet(pathnames);
var imageFolderPath = path.resolve(aggData['rootFolder'], 'docs', 'docassets', 'images');

2
tools/doc/tools/linkFixer.ts
View File

@@ -7,7 +7,7 @@ import { MDAST } from 'mdast';
const suffixesNotToCheck = /\.ts/;
export function processDocs(mdCache, aggData, errorMessages) {
export function processDocs(mdCache, aggData) {
const pathnames = Object.keys(mdCache);
const linkSet = new LinkSet(pathnames);

2
tools/doc/tools/tsInfo.js
View File

@@ -10,7 +10,7 @@ var mdNav_1 = require("../mdNav");
var ngHelpers_1 = require("../ngHelpers");
var templateFolder = path.resolve('tools', 'doc', 'templates');
var nameExceptions;
function processDocs(mdCache, aggData, _errorMessages) {
function processDocs(mdCache, aggData) {
nameExceptions = aggData.config.typeNameExceptions;
var pathnames = Object.keys(mdCache);
var internalErrors;

5
tools/doc/tools/tsInfo.ts
View File

@@ -13,7 +13,7 @@ const templateFolder = path.resolve('tools', 'doc', 'templates');
let nameExceptions;
export function processDocs(mdCache, aggData, _errorMessages) {
export function processDocs(mdCache, aggData) {
nameExceptions = aggData.config.typeNameExceptions;
const pathnames = Object.keys(mdCache);
@@ -51,6 +51,9 @@ function updateFile(tree, pathname, aggData, errorMessages) {
// Copy docs back from the .md file when the JSDocs are empty.
const inputMD = getPropDocsFromMD(tree, 'Properties', 3);
const outputMD = getPropDocsFromMD(tree, 'Events', 2);
updatePropDocsFromMD(compData, inputMD, outputMD, errorMessages);
if (classType === 'service') {

2
tools/doc/tools/versionIndex.js
View File

@@ -26,7 +26,7 @@ var initialVersion = "v2.0.0";
var templateFolder = path.resolve("tools", "doc", "templates");
function processDocs(mdCache, aggData, errorMessages) {
function processDocs(mdCache, aggData) {
initPhase(aggData);
readPhase(mdCache, aggData);
aggPhase(aggData);