stefanseifert commented on code in PR #113:
URL: 
https://github.com/apache/maven-changes-plugin/pull/113#discussion_r1973066904


##########
src/main/java/org/apache/maven/plugins/changes/ChangesReport.java:
##########
@@ -75,6 +75,21 @@ public class ChangesReport extends AbstractChangesReport {
     @Parameter(property = "changes.addActionDate", defaultValue = "false")
     private boolean addActionDate;
 
+    /**
+     * Whether the changelog action text should be passed as raw text to Doxia 
for rendering the output or not.
+     * By default, the text is passed as escaped text to Doxia to support any 
output format like HTML, PDF, etc.
+     * If you want to produce only HTML output, and want to use HTML markup in 
the changelog (e.g. anchor links)
+     * set this parameter to false.
+     *
+     * <p>
+     * <strong>Note:</strong> Only enable this paramter if you are only using 
this plugin to produce HTML output.</strong>

Review Comment:
   updated javadoc



##########
src/main/java/org/apache/maven/plugins/changes/ChangesReport.java:
##########
@@ -75,6 +75,21 @@ public class ChangesReport extends AbstractChangesReport {
     @Parameter(property = "changes.addActionDate", defaultValue = "false")
     private boolean addActionDate;
 
+    /**
+     * Whether the changelog action text should be passed as raw text to Doxia 
for rendering the output or not.
+     * By default, the text is passed as escaped text to Doxia to support any 
output format like HTML, PDF, etc.
+     * If you want to produce only HTML output, and want to use HTML markup in 
the changelog (e.g. anchor links)
+     * set this parameter to false.

Review Comment:
   updated javadoc



-- 
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: issues-unsubscr...@maven.apache.org

For queries about this service, please contact Infrastructure at:
us...@infra.apache.org

Reply via email to