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 plus some tools fix (#5100)

Browse Source 
* review 3.5.0 doc

* fix documentation

* fix documentation

* fix documentation
This commit is contained in:
Eugenio Romano
2019-09-26 10:27:04 +01:00
committed by GitHub
parent bfc7e91eb6
commit 3dc92beeb9
83 changed files with 3717 additions and 41598 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
tools/doc/sourceInfoClasses.ts
View File

@@ -132,7 +132,7 @@ export class MethodSigInfo {
this.docText = sourceData.summary || '';
this.docText = this.docText.replace(/[\n\r]+/g, ' ').trim();
if (!this.docText) {
if (!this.docText && this.name.indexOf('service') > 0) {
this.errorMessages.push(`Warning: method "${sourceData.name}" has no doc text.`);
}
@@ -145,7 +145,7 @@ export class MethodSigInfo {
this.returnsSomething = false;
}
if (this.returnsSomething && !this.returnDocText) {
if (this.returnsSomething && !this.returnDocText && this.name.indexOf('service') > 0) {
this.errorMessages.push(`Warning: Return value of method "${sourceData.name}" has no doc text.`);
}
@@ -165,7 +165,7 @@ export class MethodSigInfo {
if (sourceData.syntax.parameters) {
sourceData.syntax.parameters.forEach(rawParam => {
if (!rawParam.description) {
if (rawParam.name && !rawParam.description && !rawParam.name.startWith('on')) {
this.errorMessages.push(`Warning: parameter "${rawParam.name}" of method "${sourceData.name}" has no doc text.`);
}