(maven-jxr) branch master updated: Fix misformatted plugin documentation

[mi...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

michaelo pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/maven-jxr.git


The following commit(s) were added to refs/heads/master by this push:
     new e58908a  Fix misformatted plugin documentation
e58908a is described below

commit e58908ad7ad2a3c3ea539bcc1ba5b2a6c554834f
Author: Ashley <73...@users.noreply.github.com>
AuthorDate: Sat May 11 12:41:33 2024 +0100

    Fix misformatted plugin documentation
    
    Fixes the rendering of plugin documentation that references
    ${placeholders} as literals, which currently is not rendering correctly
    on the Maven plugin site.
    
    This closes #112
---
 .../src/main/java/org/apache/maven/plugin/jxr/AbstractJxrReport.java  | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/maven-jxr-plugin/src/main/java/org/apache/maven/plugin/jxr/AbstractJxrReport.java b/maven-jxr-plugin/src/main/java/org/apache/maven/plugin/jxr/AbstractJxrReport.java
index 569773a..f7886d7 100644
--- a/maven-jxr-plugin/src/main/java/org/apache/maven/plugin/jxr/AbstractJxrReport.java
+++ b/maven-jxr-plugin/src/main/java/org/apache/maven/plugin/jxr/AbstractJxrReport.java
@@ -83,14 +83,14 @@ public abstract class AbstractJxrReport extends AbstractMavenReport {
 
     /**
      * Directory where Velocity templates can be found to generate overviews, frames and summaries. Should not be used.
-     * If used, should be an absolute path, like {@code "${basedir}/myTemplates"}.
+     * If used, should be an absolute path, like <code>{@literal "${basedir}/myTemplates"}</code>.
      */
     @Parameter
     private String templateDir;
 
     /**
      * Style sheet used for the Xref HTML files. Should not be used. If used, should be an absolute path, like
-     * {@code "${basedir}/myStyles.css"}.
+     * <code>{@literal "${basedir}/myStyles.css"}</code>.
      */
     @Parameter
     private String stylesheet;