Skip to content

Commit 3fbb6f8

Browse files
committed
docs: generate docs
1 parent 2d88738 commit 3fbb6f8

File tree

1 file changed

+16
-0
lines changed

1 file changed

+16
-0
lines changed

README.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -899,6 +899,14 @@ function quux (foo, foo) {
899899

900900
}
901901
// Message: Duplicate @param "foo"
902+
903+
export class SomeClass {
904+
/**
905+
* @param prop
906+
*/
907+
constructor(private property: string) {}
908+
}
909+
// Message: Expected @param names to be "property". Got "prop".
902910
````
903911

904912
The following patterns are not considered problems:
@@ -4696,6 +4704,14 @@ class A {
46964704
}
46974705
}
46984706
// Message: Missing JSDoc @param "foo" declaration.
4707+
4708+
export class SomeClass {
4709+
/**
4710+
* @param property
4711+
*/
4712+
constructor(private property: string, private foo: number) {}
4713+
}
4714+
// Message: Missing JSDoc @param "foo" declaration.
46994715
````
47004716

47014717
The following patterns are not considered problems:

0 commit comments

Comments
 (0)