File tree Expand file tree Collapse file tree 1 file changed +102
-1
lines changed
Expand file tree Collapse file tree 1 file changed +102
-1
lines changed Original file line number Diff line number Diff line change 66
77[ ![ NPM version] ( https://img.shields.io/npm/v/jscs-jsdoc.svg )] ( https://www.npmjs.com/package/jscs-jsdoc )
88[ ![ NPM downloads] ( https://img.shields.io/npm/dm/jscs-jsdoc.svg )] ( https://www.npmjs.com/package/jscs-jsdoc )
9- [ ![ MIT License] ( https://img.shields.io/npm/l/jscs-jsdoc.svg )] ( https://github.com/jscs-dev/jscs-jsdoc/blob/master/LICENSExc )
9+ [ ![ MIT License] ( https://img.shields.io/npm/l/jscs-jsdoc.svg )] ( https://github.com/jscs-dev/jscs-jsdoc/blob/master/LICENSE )
1010
1111` jsdoc ` plugin for [ jscs] ( https://github.com/jscs-dev/node-jscs/ ) . [ Twitter] ( https://twitter.com/jscs_dev ) | [ Mailing List] ( https://groups.google.com/group/jscs-dev )
1212
@@ -616,6 +616,107 @@ function method() {}
616616function method () {}
617617```
618618
619+
620+ ### requireNewlineAfterDescription
621+
622+ Ensures a doc comment description has padding newline
623+
624+ Type: ` Boolean `
625+
626+ Values: ` true `
627+
628+ Context: ` functions `
629+
630+ Tags: ` * `
631+
632+ #### Example
633+
634+ ``` js
635+ " requireNewlineAfterDescription" : true
636+ ```
637+
638+ ##### Valid
639+
640+ ``` js
641+ /**
642+ * @param {String} - message
643+ */
644+ function method () {}
645+
646+ /**
647+ * Description
648+ */
649+ function method () {}
650+
651+ /**
652+ * Description
653+ *
654+ * @param {String} - message
655+ */
656+ function method () {}
657+ ```
658+
659+ ##### Invalid
660+
661+ ``` js
662+ /**
663+ * Description
664+ * @param {String} message
665+ */
666+ function method () {}
667+ ```
668+
669+
670+ ### disallowNewlineAfterDescription
671+
672+ Ensures a doc comment description has no padding newlines
673+
674+ Type: ` Boolean `
675+
676+ Values: ` true `
677+
678+ Context: ` functions `
679+
680+ Tags: ` * `
681+
682+ #### Example
683+
684+ ``` js
685+ " disallowNewlineAfterDescription" : true
686+ ```
687+
688+ ##### Valid
689+
690+ ``` js
691+ /**
692+ * @param {String} - message
693+ */
694+ function method () {}
695+
696+ /**
697+ * Description
698+ */
699+ function method () {}
700+
701+ /**
702+ * Description
703+ * @param {String} - message
704+ */
705+ function method () {}
706+ ```
707+
708+ ##### Invalid
709+
710+ ``` js
711+ /**
712+ * Description
713+ *
714+ * @param {String} message
715+ */
716+ function method () {}
717+ ```
718+
719+
619720## Browser Usage
620721
621722NOT SUPPORTED ATM. SORRY.
You can’t perform that action at this time.
0 commit comments