Finished removing unecessary (placating missing-jsdoc) JSDocs

Fixes #557
microsoft · Oct 15, 2018 · 698f0c0 · 698f0c0
1 parent dea2835
commit 698f0c0
Show file tree

Hide file tree

Showing 163 changed files with 3 additions and 489 deletions.
diff --git a/recommended_ruleset.js b/recommended_ruleset.js
@@ -125,7 +125,6 @@ module.exports = {
         "max-line-length": [true, 140],
         "member-access": true,
         "member-ordering": [true, { "order": "fields-first" }],
-        "missing-jsdoc": true,
         "mocha-unneeded-done": true,
         "new-parens": true,
         "newline-per-chained-call": true,

diff --git a/src/chaiPreferContainsToIndexOfRule.ts b/src/chaiPreferContainsToIndexOfRule.ts
@@ -8,9 +8,6 @@ import {ExtendedMetadata} from './utils/ExtendedMetadata';
 
 const FAILURE_STRING: string = 'Found chai call with indexOf that can be converted to .contain assertion: ';
 
-/**
- * Implementation of the chai-prefer-contains-to-index-of rule.
- */
 export class Rule extends Lint.Rules.AbstractRule {
 
     public static metadata: ExtendedMetadata = {

diff --git a/src/chaiVagueErrorsRule.ts b/src/chaiVagueErrorsRule.ts
@@ -12,9 +12,6 @@ const FAILURE_STRING_COMPARE_TRUE: string = BASE_ERROR + 'Move the strict equali
 const FAILURE_STRING_COMPARE_FALSE: string = BASE_ERROR + 'Move the strict inequality comparison from the expect ' +
     'call into the assertion value. ';
 
-/**
- * Implementation of the chai-vague-errors rule.
- */
 export class Rule extends Lint.Rules.AbstractRule {
 
     public static metadata: ExtendedMetadata = {

diff --git a/src/exportNameRule.ts b/src/exportNameRule.ts
@@ -8,9 +8,7 @@ import {AstUtils} from './utils/AstUtils';
 import {ExtendedMetadata} from './utils/ExtendedMetadata';
 
 export const OPTION_IGNORE_CASE: string = 'ignore-case';
-/**
- * Implementation of the export-name rule.
- */
+
 export class Rule extends Lint.Rules.AbstractRule {
 
     public static metadata: ExtendedMetadata = {

diff --git a/src/functionNameRule.ts b/src/functionNameRule.ts
@@ -40,9 +40,6 @@ interface Options {
     readonly validateStatics: string;
 }
 
-/**
- * Implementation of the function-name rule.
- */
 export class Rule extends Lint.Rules.AbstractRule {
 
     public static metadata: ExtendedMetadata = {

diff --git a/src/importNameRule.ts b/src/importNameRule.ts
@@ -5,9 +5,6 @@ import {ErrorTolerantWalker} from './utils/ErrorTolerantWalker';
 import {Utils} from './utils/Utils';
 import {ExtendedMetadata} from './utils/ExtendedMetadata';
 
-/**
- * Implementation of the import-name rule.
- */
 export class Rule extends Lint.Rules.AbstractRule {
 
     public static metadata: ExtendedMetadata = {

diff --git a/src/insecureRandomRule.ts b/src/insecureRandomRule.ts
@@ -10,9 +10,6 @@ const MATH_FAIL_STRING: string = 'Math.random produces insecure random numbers.
 const NODE_FAIL_STRING: string = 'crypto.pseudoRandomBytes produces insecure random numbers. ' +
     'Use crypto.randomBytes() instead';
 
-/**
- * Implementation of the insecure-random rule.
- */
 export class Rule extends Lint.Rules.AbstractRule {
 
     public static metadata: ExtendedMetadata = {

diff --git a/src/jqueryDeferredMustCompleteRule.ts b/src/jqueryDeferredMustCompleteRule.ts
@@ -6,9 +6,6 @@ import {AstUtils} from './utils/AstUtils';
 import {Utils} from './utils/Utils';
 import {ExtendedMetadata} from './utils/ExtendedMetadata';
 
-/**
- * Implementation of the jquery-deferred-must-complete rule.
- */
 export class Rule extends Lint.Rules.AbstractRule {
 
     public static metadata: ExtendedMetadata = {

diff --git a/src/maxFuncBodyLengthRule.ts b/src/maxFuncBodyLengthRule.ts
@@ -5,9 +5,6 @@ import {Utils} from './utils/Utils';
 import {ExtendedMetadata} from './utils/ExtendedMetadata';
 import {forEachTokenWithTrivia} from 'tsutils';
 
-/**
- * Implementation of the max-func-body-length rule.
- */
 export class Rule extends Lint.Rules.AbstractRule {
 
     public static metadata: ExtendedMetadata = {

diff --git a/src/missingJsdocRule.ts b/src/missingJsdocRule.ts
@@ -4,9 +4,6 @@ import * as Lint from 'tslint';
 import {ErrorTolerantWalker} from './utils/ErrorTolerantWalker';
 import {ExtendedMetadata} from './utils/ExtendedMetadata';
 
-/**
- * Implementation of the missing-jsdoc rule.
- */
 export class Rule extends Lint.Rules.AbstractRule {
 
     public static metadata: ExtendedMetadata = {
@@ -16,7 +13,7 @@ export class Rule extends Lint.Rules.AbstractRule {
         options: null,
         optionsDescription: '',
         typescriptOnly: true,
-        issueClass: 'Non-SDL',
+        issueClass: 'Ignored',
         issueType: 'Warning',
         severity: 'Low',
         level: 'Opportunity for Excellence',

diff --git a/src/missingOptionalAnnotationRule.ts b/src/missingOptionalAnnotationRule.ts
@@ -4,9 +4,6 @@ import * as Lint from 'tslint';
 import {ErrorTolerantWalker} from './utils/ErrorTolerantWalker';
 import {ExtendedMetadata} from './utils/ExtendedMetadata';
 
-/**
- * Implementation of the missing-optional-annotation rule.
- */
 export class Rule extends Lint.Rules.AbstractRule {
 
     public static metadata: ExtendedMetadata = {

diff --git a/src/mochaAvoidOnlyRule.ts b/src/mochaAvoidOnlyRule.ts
@@ -5,9 +5,6 @@ import {ErrorTolerantWalker} from './utils/ErrorTolerantWalker';
 import {ExtendedMetadata} from './utils/ExtendedMetadata';
 import {MochaUtils} from './utils/MochaUtils';
 
-/**
- * Implementation of the mocha-avoid-only rule.
- */
 export class Rule extends Lint.Rules.AbstractRule {
 
     public static metadata: ExtendedMetadata = {

diff --git a/src/mochaNoSideEffectCodeRule.ts b/src/mochaNoSideEffectCodeRule.ts
@@ -9,9 +9,6 @@ import {Utils} from './utils/Utils';
 
 const FAILURE_STRING: string = 'Mocha test contains dangerous variable initialization. Move to before()/beforeEach(): ';
 
-/**
- * Implementation of the mocha-no-side-effect-code rule.
- */
 export class Rule extends Lint.Rules.AbstractRule {
 
     public static metadata: ExtendedMetadata = {

diff --git a/src/mochaUnneededDoneRule.ts b/src/mochaUnneededDoneRule.ts
@@ -8,9 +8,6 @@ import {MochaUtils} from './utils/MochaUtils';
 
 const FAILURE_STRING: string = 'Unneeded Mocha Done. Parameter can be safely removed: ';
 
-/**
- * Implementation of the mocha-unneeded-done rule.
- */
 export class Rule extends Lint.Rules.AbstractRule {
 
     public static metadata: ExtendedMetadata = {

diff --git a/src/noBackboneGetSetOutsideModelRule.ts b/src/noBackboneGetSetOutsideModelRule.ts
@@ -5,12 +5,6 @@ import {ErrorTolerantWalker} from './utils/ErrorTolerantWalker';
 import {AstUtils} from './utils/AstUtils';
 import {ExtendedMetadata} from './utils/ExtendedMetadata';
 
-/**
- * Implementation of the no-backbone-get-set-outside-model rule.
- *
- * Currently only makes sure that get and set Backbone methods are called
- * on the this reference.
- */
 export class Rule extends Lint.Rules.AbstractRule {
 
     public static metadata: ExtendedMetadata = {

diff --git a/src/noBannedTermsRule.ts b/src/noBannedTermsRule.ts
@@ -4,9 +4,6 @@ import * as Lint from 'tslint';
 import {ExtendedMetadata} from './utils/ExtendedMetadata';
 import {BannedTermWalker} from './utils/BannedTermWalker';
 
-/**
- * Implementation of the no-banned-terms rule.
- */
 export class Rule extends Lint.Rules.AbstractRule {
 
     public static metadata: ExtendedMetadata = {

diff --git a/src/noConstantConditionRule.ts b/src/noConstantConditionRule.ts
@@ -5,9 +5,6 @@ import {AstUtils} from './utils/AstUtils';
 import {ErrorTolerantWalker} from './utils/ErrorTolerantWalker';
 import {ExtendedMetadata} from './utils/ExtendedMetadata';
 
-/**
- * Implementation of the no-constant-condition rule.
- */
 export class Rule extends Lint.Rules.AbstractRule {
 
     public static metadata: ExtendedMetadata = {

diff --git a/src/noControlRegexRule.ts b/src/noControlRegexRule.ts
@@ -4,9 +4,6 @@ import * as Lint from 'tslint';
 import {ErrorTolerantWalker} from './utils/ErrorTolerantWalker';
 import {ExtendedMetadata} from './utils/ExtendedMetadata';
 
-/**
- * Implementation of the no-control-regex rule.
- */
 export class Rule extends Lint.Rules.AbstractRule {
 
     public static metadata: ExtendedMetadata = {

diff --git a/src/noCookiesRule.ts b/src/noCookiesRule.ts
@@ -4,9 +4,6 @@ import * as Lint from 'tslint';
 import {ErrorTolerantWalker} from './utils/ErrorTolerantWalker';
 import {ExtendedMetadata} from './utils/ExtendedMetadata';
 
-/**
- * Implementation of the no-cookies-rule rule.
- */
 export class Rule extends Lint.Rules.TypedRule {
 
     public static metadata: ExtendedMetadata = {

diff --git a/src/noDeleteExpressionRule.ts b/src/noDeleteExpressionRule.ts
@@ -4,9 +4,6 @@ import * as Lint from 'tslint';
 import {ErrorTolerantWalker} from './utils/ErrorTolerantWalker';
 import {ExtendedMetadata} from './utils/ExtendedMetadata';
 
-/**
- * Implementation of the no-delete-expression rule.
- */
 export class Rule extends Lint.Rules.AbstractRule {
 
     public static metadata: ExtendedMetadata = {

diff --git a/src/noDisableAutoSanitizationRule.ts b/src/noDisableAutoSanitizationRule.ts
@@ -5,9 +5,6 @@ import {ErrorTolerantWalker} from './utils/ErrorTolerantWalker';
 import {AstUtils} from './utils/AstUtils';
 import {ExtendedMetadata} from './utils/ExtendedMetadata';
 
-/**
- * Implementation of the no-disable-auto-sanitization rule.
- */
 export class Rule extends Lint.Rules.AbstractRule {
 
     public static metadata: ExtendedMetadata = {

diff --git a/src/noDocumentDomainRule.ts b/src/noDocumentDomainRule.ts
@@ -4,9 +4,6 @@ import * as Lint from 'tslint';
 import {ErrorTolerantWalker} from './utils/ErrorTolerantWalker';
 import {ExtendedMetadata} from './utils/ExtendedMetadata';
 
-/**
- * Implementation of the no-document-domain rule.
- */
 export class Rule extends Lint.Rules.AbstractRule {
 
     public static metadata: ExtendedMetadata = {

diff --git a/src/noDocumentWriteRule.ts b/src/noDocumentWriteRule.ts
@@ -5,9 +5,6 @@ import {ErrorTolerantWalker} from './utils/ErrorTolerantWalker';
 import {AstUtils} from './utils/AstUtils';
 import {ExtendedMetadata} from './utils/ExtendedMetadata';
 
-/**
- * Implementation of the no-document-write rule.
- */
 export class Rule extends Lint.Rules.AbstractRule {
 
     public static metadata: ExtendedMetadata = {

diff --git a/src/noDuplicateCaseRule.ts b/src/noDuplicateCaseRule.ts
@@ -4,9 +4,6 @@ import * as Lint from 'tslint';
 import {ErrorTolerantWalker} from './utils/ErrorTolerantWalker';
 import {ExtendedMetadata} from './utils/ExtendedMetadata';
 
-/**
- * Implementation of the no-duplicate-case rule.
- */
 export class Rule extends Lint.Rules.AbstractRule {
 
     public static metadata: ExtendedMetadata = {

diff --git a/src/noDuplicateParameterNamesRule.ts b/src/noDuplicateParameterNamesRule.ts
@@ -4,9 +4,6 @@ import * as Lint from 'tslint';
 import {ErrorTolerantWalker} from './utils/ErrorTolerantWalker';
 import {ExtendedMetadata} from './utils/ExtendedMetadata';
 
-/**
- * Implementation of the no-duplicate-parameter-names rule.
- */
 export class Rule extends Lint.Rules.AbstractRule {
 
     public static metadata: ExtendedMetadata = {

diff --git a/src/noEmptyInterfacesRule.ts b/src/noEmptyInterfacesRule.ts
@@ -4,9 +4,6 @@ import * as Lint from 'tslint';
 import {ErrorTolerantWalker} from './utils/ErrorTolerantWalker';
 import {ExtendedMetadata} from './utils/ExtendedMetadata';
 
-/**
- * Implementation of the no-empty-interfaces rule.
- */
 export class Rule extends Lint.Rules.AbstractRule {
 
     public static metadata: ExtendedMetadata = {

diff --git a/src/noEmptyLineAfterOpeningBraceRule.ts b/src/noEmptyLineAfterOpeningBraceRule.ts
@@ -5,9 +5,6 @@ import {ErrorTolerantWalker} from './utils/ErrorTolerantWalker';
 import {ExtendedMetadata} from './utils/ExtendedMetadata';
 import {forEachTokenWithTrivia} from 'tsutils';
 
-/**
- * Implementation of the no-empty-line-after-opening-brace rule.
- */
 export class Rule extends Lint.Rules.AbstractRule {
 
     public static metadata: ExtendedMetadata = {

diff --git a/src/noExecScriptRule.ts b/src/noExecScriptRule.ts
@@ -6,9 +6,6 @@ import {ExtendedMetadata} from './utils/ExtendedMetadata';
 
 import {AstUtils} from './utils/AstUtils';
 
-/**
- * Implementation of the no-exec-script rule.
- */
 export class Rule extends Lint.Rules.AbstractRule {
 
     public static metadata: ExtendedMetadata = {

diff --git a/src/noForInRule.ts b/src/noForInRule.ts
@@ -4,9 +4,6 @@ import * as Lint from 'tslint';
 import {ErrorTolerantWalker} from './utils/ErrorTolerantWalker';
 import {ExtendedMetadata} from './utils/ExtendedMetadata';
 
-/**
- * Implementation of the no-for-in rule.
- */
 export class Rule extends Lint.Rules.AbstractRule {
 
     public static metadata: ExtendedMetadata = {

diff --git a/src/noFunctionConstructorWithStringArgsRule.ts b/src/noFunctionConstructorWithStringArgsRule.ts
@@ -5,9 +5,6 @@ import {ErrorTolerantWalker} from './utils/ErrorTolerantWalker';
 import {AstUtils} from './utils/AstUtils';
 import {ExtendedMetadata} from './utils/ExtendedMetadata';
 
-/**
- * Implementation of the no-function-constructor-with-string-args rule.
- */
 export class Rule extends Lint.Rules.AbstractRule {
 
     public static metadata: ExtendedMetadata = {

diff --git a/src/noFunctionExpressionRule.ts b/src/noFunctionExpressionRule.ts
@@ -5,9 +5,6 @@ import { AstUtils } from './utils/AstUtils';
 import {ErrorTolerantWalker} from './utils/ErrorTolerantWalker';
 import {ExtendedMetadata} from './utils/ExtendedMetadata';
 
-/**
- * Implementation of the no-function-expression rule.
- */
 export class Rule extends Lint.Rules.AbstractRule {
 
     public static metadata: ExtendedMetadata = {

diff --git a/src/noHttpStringRule.ts b/src/noHttpStringRule.ts
@@ -5,9 +5,6 @@ import {ErrorTolerantWalker} from './utils/ErrorTolerantWalker';
 import {Utils} from './utils/Utils';
 import {ExtendedMetadata} from './utils/ExtendedMetadata';
 
-/**
- * Implementation of the no-http-string rule.
- */
 export class Rule extends Lint.Rules.AbstractRule {
 
     public static metadata: ExtendedMetadata = {

diff --git a/src/noIncrementDecrementRule.ts b/src/noIncrementDecrementRule.ts
@@ -4,9 +4,6 @@ import * as Lint from 'tslint';
 import {ErrorTolerantWalker} from './utils/ErrorTolerantWalker';
 import {ExtendedMetadata} from './utils/ExtendedMetadata';
 
-/**
- * Implementation of the no-increment-decrement rule.
- */
 export class Rule extends Lint.Rules.AbstractRule {
 
     public static metadata: ExtendedMetadata = {

diff --git a/src/noInnerHtmlRule.ts b/src/noInnerHtmlRule.ts
@@ -9,9 +9,6 @@ const FAILURE_INNER: string = 'Writing a string to the innerHTML property is ins
 const FAILURE_OUTER: string = 'Writing a string to the outerHTML property is insecure: ';
 const FAILURE_HTML_LIB: string = 'Using the html() function to write a string to innerHTML is insecure: ';
 
-/**
- * Implementation of the no-inner-html rule.
- */
 export class Rule extends Lint.Rules.AbstractRule {
 
     public static metadata: ExtendedMetadata = {

diff --git a/src/noInvalidRegexpRule.ts b/src/noInvalidRegexpRule.ts
@@ -4,9 +4,6 @@ import * as Lint from 'tslint';
 import {ErrorTolerantWalker} from './utils/ErrorTolerantWalker';
 import {ExtendedMetadata} from './utils/ExtendedMetadata';
 
-/**
- * Implementation of the no-invalid-regexp rule.
- */
 export class Rule extends Lint.Rules.AbstractRule {
 
     public static metadata: ExtendedMetadata = {

diff --git a/src/noJqueryRawElementsRule.ts b/src/noJqueryRawElementsRule.ts
@@ -6,9 +6,6 @@ import {ExtendedMetadata} from './utils/ExtendedMetadata';
 const FAILURE_STRING_MANIPULATION: string = 'Replace HTML string manipulation with jQuery API: ';
 const FAILURE_STRING_COMPLEX: string = 'Replace complex HTML strings with jQuery API: ';
 
-/**
- * Implementation of the no-jquery-raw-elements rule.
- */
 export class Rule extends Lint.Rules.AbstractRule {
 
     public static metadata: ExtendedMetadata = {

diff --git a/src/noMissingVisibilityModifiersRule.ts b/src/noMissingVisibilityModifiersRule.ts
@@ -5,9 +5,6 @@ import {ErrorTolerantWalker} from './utils/ErrorTolerantWalker';
 import {AstUtils} from './utils/AstUtils';
 import {ExtendedMetadata} from './utils/ExtendedMetadata';
 
-/**
- * Implementation of the mo-missing-visibility-modifiers rule.
- */
 export class Rule extends Lint.Rules.AbstractRule {
 
     public static metadata: ExtendedMetadata = {

diff --git a/src/noMultilineStringRule.ts b/src/noMultilineStringRule.ts
@@ -4,9 +4,6 @@ import * as Lint from 'tslint';
 import {ErrorTolerantWalker} from './utils/ErrorTolerantWalker';
 import {ExtendedMetadata} from './utils/ExtendedMetadata';
 
-/**
- * Implementation of the no-multiline-string rule.
- */
 export class Rule extends Lint.Rules.AbstractRule {
 
     public static metadata: ExtendedMetadata = {