Skip to content

Commit c0c53d6

Browse files
committed
Updated usage
1 parent 9fbcf86 commit c0c53d6

File tree

1 file changed

+1
-0
lines changed

1 file changed

+1
-0
lines changed

README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@ Generates a Markdown file which contains documentation for specific java classes
1616

1717
## Usage
1818
`java -jar javadocsgenerator-VERSION.jar --files=FILENAME.java,ANOTHER_FILENAME.java,... --output=JAVA_DOCS.md`
19+
> NOTE: To use a class for documentation generation add a '//DOC' comment over the class declaration and over every method which you want to use. Alternatively you can use java doc comments for methods.
1920
2021
Arguments:\
2122
`--files`: Required. Specifies the files that should be used for documentation generation.\

0 commit comments

Comments
 (0)