This repository has been archived by the owner on Mar 25, 2021. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 889
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Added location, type, and privacy to completed-docs (#2095)
Also adds interfaces, enums, types, and a few other doc-able contructs.
- Loading branch information
Showing
14 changed files
with
747 additions
and
156 deletions.
There are no files selected for viewing
Large diffs are not rendered by default.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
export class Aaa { | ||
~~~~~~~~~~~~~~~~~~ [Documentation must exist for exported classes.] | ||
public bbb; | ||
~~~~~~~~~~~ [Documentation must exist for public properties.] | ||
|
||
public ccc() { } | ||
~~~~~~~~~~~~~~~~ [Documentation must exist for public methods.] | ||
} | ||
|
||
export enum Ddd { } | ||
|
||
export function Eee() { } | ||
~~~~~~~~~~~~~~~~~~~~~~~~~ [Documentation must exist for exported functions.] | ||
|
||
export interface Fff { } | ||
|
||
export namespace Ggg { } | ||
|
||
export type Hhh = any; | ||
|
||
export const i = true; |
File renamed without changes.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,31 @@ | ||
class Class { | ||
badInstanceProperty = 1; | ||
|
||
/** | ||
* ... | ||
*/ | ||
goodInstanceProperty = 1; | ||
|
||
/** | ||
* ... | ||
*/ | ||
static badStaticProperty = 1; | ||
|
||
static goodStaticProperty = 1; | ||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ [Documentation must exist for static properties.] | ||
|
||
badInstanceMethod() { } | ||
~~~~~~~~~~~~~~~~~~~~~~~ [Documentation must exist for methods.] | ||
|
||
/** | ||
* ... | ||
*/ | ||
goodInstanceMethod() { } | ||
|
||
static badStaticMethod() { } | ||
|
||
/** | ||
* ... | ||
*/ | ||
static goodStaticMethod() { } | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,15 @@ | ||
{ | ||
"linterOptions": { | ||
"typeCheck": true | ||
}, | ||
"rules": { | ||
"completed-docs": [true, { | ||
"methods": { | ||
"locations": ["instance"] | ||
}, | ||
"properties": { | ||
"locations": ["static"] | ||
} | ||
}] | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,33 @@ | ||
class Class { | ||
badDefaultMethod() { } | ||
~~~~~~~~~~~~~~~~~~~~~~ [Documentation must exist for methods.] | ||
|
||
/** | ||
* ... | ||
*/ | ||
goodDefaultMethod() { } | ||
|
||
public badPublicMethod() { } | ||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~ [Documentation must exist for public methods.] | ||
|
||
/** | ||
* ... | ||
*/ | ||
public goodPublicMethod() { } | ||
|
||
protected badProtectedMethod() { } | ||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ [Documentation must exist for protected methods.] | ||
|
||
/** | ||
* ... | ||
*/ | ||
protected goodProtectedMethod() { } | ||
|
||
private badPrivateMethod() { } | ||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ [Documentation must exist for private methods.] | ||
|
||
/** | ||
* ... | ||
*/ | ||
private goodPrivateMethod() { } | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,15 @@ | ||
{ | ||
"linterOptions": { | ||
"typeCheck": true | ||
}, | ||
"rules": { | ||
"completed-docs": [true, { | ||
"methods": { | ||
"visibilities": ["public", "protected"] | ||
}, | ||
"properties": { | ||
"visibilities": ["public"] | ||
} | ||
}] | ||
} | ||
} |
Oops, something went wrong.