Skip to content

Commit 9e56f72

Browse files
dtracersAlexej Yaroshevich
authored andcommitted
Docs: Add requireDescriptionCompleteSentence to readme.
Fixes #106 Closes gh-109
1 parent 152ab67 commit 9e56f72

File tree

1 file changed

+78
-0
lines changed

1 file changed

+78
-0
lines changed

README.md

Lines changed: 78 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -716,6 +716,84 @@ function method() {}
716716
function method() {}
717717
```
718718

719+
### requireDescriptionCompleteSentence
720+
721+
Ensures a doc comment description is a complete sentence.
722+
723+
A complete sentence is defined as starting with an upper case letter and ending with a period.
724+
725+
Type: `Boolean`
726+
727+
Values: `true`
728+
729+
Context: `functions`
730+
731+
Tags: `*`
732+
733+
#### Example
734+
735+
```js
736+
"requireDescriptionCompleteSentence": true
737+
```
738+
739+
##### Valid
740+
741+
```js
742+
/**
743+
* @param {String} - message
744+
*/
745+
function method() {}
746+
747+
/**
748+
* Description.
749+
*/
750+
function method() {}
751+
752+
/**
753+
* Description.
754+
*
755+
* @param {String} - message
756+
*/
757+
function method() {}
758+
759+
/**
760+
* Description
761+
* On multiple lines.
762+
*
763+
* @param {String} - message
764+
*/
765+
function method() {}
766+
```
767+
768+
##### Invalid
769+
770+
```js
771+
/**
772+
* Description
773+
* @param {String} message
774+
*/
775+
function method() {}
776+
777+
/**
778+
* description starting with a lower case letter.
779+
* @param {String} message
780+
*/
781+
function method() {}
782+
783+
/**
784+
* Description period is offset .
785+
* @param {String} message
786+
*/
787+
function method() {}
788+
789+
/**
790+
* Description!
791+
* @param {String} message
792+
*/
793+
function method() {}
794+
```
795+
796+
719797

720798
## Browser Usage
721799

0 commit comments

Comments
 (0)