Skip to content

Commit 21f5eda

Browse files
committed
Docs: fix mistyped example for requireDescriptionCompleteSentense
And some other trivial fixes Fixes #153
1 parent b9ffead commit 21f5eda

File tree

1 file changed

+24
-16
lines changed

1 file changed

+24
-16
lines changed

README.md

Lines changed: 24 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -698,9 +698,9 @@ Tags: `*`
698698

699699
```js
700700
/**
701-
* @param {String} - message
701+
* @param {String} msg - message
702702
*/
703-
function method() {}
703+
function method(msg) {}
704704

705705
/**
706706
* Description
@@ -710,9 +710,9 @@ function method() {}
710710
/**
711711
* Description
712712
*
713-
* @param {String} - message
713+
* @param {String} msg - message
714714
*/
715-
function method() {}
715+
function method(msg) {}
716716
```
717717

718718
##### Invalid
@@ -748,9 +748,9 @@ Tags: `*`
748748

749749
```js
750750
/**
751-
* @param {String} - message
751+
* @param {String} msg - message
752752
*/
753-
function method() {}
753+
function method(msg) {}
754754

755755
/**
756756
* Description
@@ -759,9 +759,9 @@ function method() {}
759759

760760
/**
761761
* Description
762-
* @param {String} - message
762+
* @param {String} msg - message
763763
*/
764-
function method() {}
764+
function method(msg) {}
765765
```
766766

767767
##### Invalid
@@ -772,7 +772,7 @@ function method() {}
772772
*
773773
* @param {String} message
774774
*/
775-
function method() {}
775+
function method(message) {}
776776
```
777777

778778

@@ -801,9 +801,9 @@ Tags: `*`
801801

802802
```js
803803
/**
804-
* @param {String} - message
804+
* @param {String} msg - message
805805
*/
806-
function method() {}
806+
function method(msg) {}
807807

808808
/**
809809
* Description.
@@ -818,17 +818,17 @@ function method() {}
818818
/**
819819
* Description.
820820
*
821-
* @param {String} - message
821+
* @param {String} msg - message
822822
*/
823-
function method() {}
823+
function method(msg) {}
824824

825825
/**
826826
* Description
827-
* On multiple lines.
827+
* on multiple lines are allowed.
828828
*
829-
* @param {String} - message
829+
* @param {String} msg - message
830830
*/
831-
function method() {}
831+
function method(msg) {}
832832
```
833833

834834
##### Invalid
@@ -840,6 +840,14 @@ function method() {}
840840
*/
841841
function method() {}
842842

843+
/**
844+
* Description
845+
* On multiple lines should not start with an upper case.
846+
*
847+
* @param {String} - message
848+
*/
849+
function method() {}
850+
843851
/**
844852
* description starting with a lower case letter.
845853
* @param {String} message

0 commit comments

Comments
 (0)