File tree Expand file tree Collapse file tree 1 file changed +78
-0
lines changed Expand file tree Collapse file tree 1 file changed +78
-0
lines changed Original file line number Diff line number Diff line change @@ -716,6 +716,84 @@ function method() {}
716
716
function method () {}
717
717
```
718
718
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
+
719
797
720
798
## Browser Usage
721
799
You can’t perform that action at this time.
0 commit comments