elharo commented on code in PR #172: URL: https://github.com/apache/maven-javadoc-plugin/pull/172#discussion_r1014723892
########## src/site/apt/examples/fix-javadocs.apt.vm: ########## @@ -28,39 +28,39 @@ Fixing Javadoc Comments - When developers write code, they could forget to create (or update) the Javadoc comments. The <fix> and <test-fix> + When developers write code, they often forget to create (or update) the Javadoc comments. The <fix> and <test-fix> goals are interactive goals (i.e. used generally in command line) to fix the actual Javadoc comments in your classes. You need to call <mvn javadoc:fix> to fix main Java source files (i.e. inside src/main/java directory) or <mvn javadoc:test-fix> to fix test Java source files (i.e. inside src/test/java directory). - <<Important Note>>: Since the changes are done <<directly>> in the source code, we recommend <<strongly>> the use of - a SCM, so you could always do a revert if a problem occurs. You could always add <<<-DoutputDirectory=/path/to/dir>>> - to specify a target directory where classes will be generated. + <<Important Note>>: Since the changes are done <<directly>> in the source code by default, we <<strongly>> recommend using + a SCM, so you cab revert if a problem occurs. You can also add <<<-DoutputDirectory=/path/to/dir>>> Review Comment: can. Thanks for the catch. Fixed. -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
