gnodet-bot commented on code in PR #1120: URL: https://github.com/apache/maven-compiler-plugin/pull/1120#discussion_r4087063746
########## src/site/markdown/examples/annotation-processor.md: ########## @@ -87,21 +87,21 @@ The following example shows this. ``` Like ordinary dependencies, processors can be placed on the processor class-path or processor module-path. -Each processor can be placed explicitly on one of those two kinds of path by specifying the +Each processor can be placed on one of these two kinds of path. Specify the `classpath-processor` or `modular-processor` dependency type respectively. -If the specified type is only `processor`, then the Maven compiler plugin will try to guess on which path to place the processor. -Note that this guess is not guaranteed to be correct. -Developers are encouraged to declare a more explicit type (for example `<type>classpath-processor</type>`) when they know how the processor is intended to be used. +If the specified type is only `processor`, then the Maven compiler plugin guesses which path to place the processor on. +This guess is not guaranteed to be correct. +When you know how the processor is intended to be used, declare a more explicit type (for example `<type>classpath-processor</type>`). ## Not recommended: Using the `proc` configuration This section applies to Maven 3 and Maven 4. -If you don't want to provide a list of processors, you have to set the value of the `<proc>` configuration to either `only` or `full`. -The first will only scan the classpath for annotation processors and will execute them, while the later will also compile the code afterward. -Keep in mind that if no list of desired annotation processors is provided, using the `<proc>` configuration will execute found processors on the classpath. -**This might result in the execution of hidden and possible malicious processors.** +If you do not want to provide a list of processors, set the value of the `<proc>` configuration to `only` or `full`. +`only` scans the classpath for annotation processors and executes them. `full` also compiles the code afterward. Review Comment: 🔴 **Double space: `only` scans → `only` scans.** There are two spaces between the closing backtick of ``only`` and the word "scans". This renders as a double space in HTML output (in pre/code context it is visible). ```suggestion `only` scans the classpath for annotation processors and executes them. `full` also compiles the code afterward. ``` ########## src/site/markdown/examples/pass-compiler-arguments.md: ########## @@ -22,7 +22,6 @@ under the License. Sometimes, you need to pass compiler arguments that are not handled by the Compiler Plugin itself. For such arguments, use the Compiler Plugin's `compilerArgs` parameter. The following example passes compiler arguments to the `javac` compiler: Review Comment: 🔴 **Formatting regression: blank line before code fence removed.** The blank line separating the prose paragraph from the ````xml```` fence was deleted. In Doxia/Markdown, a fenced code block must be preceded by a blank line when it follows a paragraph. Without it the fence is treated as inline content and the XML snippet will not render as a code block. ```suggestion The following example passes compiler arguments to the `javac` compiler: ``` ########## src/site/markdown/examples/set-compiler-release.md: ########## @@ -72,7 +72,6 @@ Since version 4 of the compiler plugin, which requires Maven 4, the preferred way to specify the release is together with the source declaration. This is the recommended way because it makes the creation of [multi-release](../multirelease.html) projects easier. - ```xml Review Comment: 🔴 **Formatting regression: blank line before code fence removed (Maven 4 section).** Same issue as in `pass-compiler-arguments.md`: the blank line between the prose ending with "projects easier." and the ````xml```` fence was removed. The code block will not render correctly without the blank separator. ```suggestion [multi-release](../multirelease.html) projects easier. ``` -- 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]
