Skip to content

Commit bb94310

Browse files
committed
Re-adding missing docs.
1 parent a5a367a commit bb94310

File tree

5 files changed

+113
-0
lines changed

5 files changed

+113
-0
lines changed

.README/rules/check-tag-names.md

Lines changed: 77 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,77 @@
1+
### `check-tag-names`
2+
3+
Reports invalid block tag names.
4+
5+
Valid [JSDoc 3 Block Tags](http://usejsdoc.org/#block-tags) are:
6+
7+
```
8+
abstract
9+
access
10+
alias
11+
augments
12+
author
13+
borrows
14+
callback
15+
class
16+
classdesc
17+
constant
18+
constructs
19+
copyright
20+
default
21+
deprecated
22+
description
23+
enum
24+
event
25+
example
26+
exports
27+
external
28+
file
29+
fires
30+
function
31+
global
32+
ignore
33+
implements
34+
inheritdoc
35+
inner
36+
instance
37+
interface
38+
kind
39+
lends
40+
license
41+
listens
42+
member
43+
memberof
44+
mixes
45+
mixin
46+
module
47+
name
48+
namespace
49+
override
50+
param
51+
private
52+
property
53+
protected
54+
public
55+
readonly
56+
requires
57+
returns
58+
see
59+
since
60+
static
61+
summary
62+
this
63+
throws
64+
todo
65+
tutorial
66+
type
67+
typedef
68+
variation
69+
version
70+
```
71+
72+
|||
73+
|---|---|
74+
|Context|`ArrowFunctionExpression`, `FunctionDeclaration`, `FunctionExpression`|
75+
|Tags|N/A|
76+
77+
<!-- assertions checkTagNames -->
Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
### `require-description-complete-sentence`
2+
3+
Requires that block description and tag description are written in complete sentences, i.e.,
4+
5+
* Description must start with an uppercase alphabetical character.
6+
* Paragraph must start with an uppercase alphabetical character.
7+
* Sentences must end with a period.
8+
* Every line that starts with a lowercase character must be preceded by a line ending the sentence.
9+
10+
|||
11+
|---|---|
12+
|Context|`ArrowFunctionExpression`, `FunctionDeclaration`, `FunctionExpression`|
13+
|Tags|`param`, `returns`|
14+
15+
<!-- assertions requireDescriptionCompleteSentence -->

.README/rules/require-param-type.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
### `require-param-type`
2+
3+
Requires that `@param` tag has `type` value.
4+
5+
|||
6+
|---|---|
7+
|Context|`ArrowFunctionExpression`, `FunctionDeclaration`, `FunctionExpression`|
8+
|Tags|`param`|
9+
10+
<!-- assertions requireParamType -->

.README/rules/require-returns-type.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
### `require-returns-type`
2+
3+
Requires that `@returns` tag has `type` value.
4+
5+
|||
6+
|---|---|
7+
|Context|`ArrowFunctionExpression`, `FunctionDeclaration`, `FunctionExpression`|
8+
|Tags|`returns`|
9+
10+
<!-- assertions requireReturnsType -->

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,3 +7,4 @@ dist
77
!.npmignore
88
!.babelrc
99
!.travis.yml
10+
!.README

0 commit comments

Comments
 (0)