File tree Expand file tree Collapse file tree 1 file changed +46
-0
lines changed
Expand file tree Collapse file tree 1 file changed +46
-0
lines changed Original file line number Diff line number Diff line change @@ -716,6 +716,7 @@ function method() {}
716716function method () {}
717717```
718718
719+
719720### requireDescriptionCompleteSentence
720721
721722Ensures a doc comment description is a complete sentence.
@@ -794,6 +795,51 @@ function method() {}
794795```
795796
796797
798+ ### requireParamDescription
799+
800+ Ensures a param description exists.
801+
802+ Type: ` Boolean `
803+
804+ Values: ` true `
805+
806+ Context: ` functions `
807+
808+ Tags: ` param ` , ` arg ` , ` argument `
809+
810+ #### Example
811+
812+ ``` js
813+ " requireParamDescription" : true
814+ ```
815+
816+ ##### Valid
817+
818+ ``` js
819+ /**
820+ * @param {String} arg message
821+ */
822+ function method (arg ) {}
823+
824+ /**
825+ * @param arg message
826+ */
827+ function method (arg ) {}
828+
829+ ##### Invalid
830+
831+ ` ` ` js
832+ /**
833+ * @param {String} arg
834+ */
835+ function method(arg) {}
836+
837+ /**
838+ * @param arg
839+ */
840+ function method(arg) {}
841+ ` ` `
842+
797843
798844## Browser Usage
799845
You can’t perform that action at this time.
0 commit comments