Merge pull request #16 from mojohaus/#15_invalid_tags

[#15] fix invalid javadoc tags // add custom tags.
mojohaus · Jan 15, 2022 · 11ae80a · 11ae80a
2 parents ded0144 + 776f66e
commit 11ae80a
Show file tree

Hide file tree

Showing 6 changed files with 60 additions and 21 deletions.
diff --git a/pom.xml b/pom.xml
@@ -16,6 +16,7 @@
  <url>http://www.mojohaus.org/taglist-maven-plugin/</url>
  <properties>
  <mavenVersion>2.2.1</mavenVersion>
+ <plugin.maven-javadoc-plugin.version>3.3.1</plugin.maven-javadoc-plugin.version>
  </properties>
  <prerequisites>
  <maven>${mavenVersion}</maven>
@@ -79,6 +80,39 @@
  <url>https://github.com/mojohaus/taglist-maven-plugin</url>
  </scm>
  <build>
+ <pluginManagement>
+ <plugins>
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-javadoc-plugin</artifactId>
+ <version>${plugin.maven-javadoc-plugin.version}</version>
+ <configuration>
+ <tags>
+ <tag>
+ <name>todo</name>
+ <placement>a</placement>
+ <head>TODO:</head>
+ </tag>
+ <tag>
+ <name>goal</name>
+ <placement>a</placement>
+ <head>GOAL:</head>
+ </tag>
+ <tag>
+ <name>requiresProject</name>
+ <placement>a</placement>
+ <head>Requires Project:</head>
+ </tag>
+ <tag>
+ <name>threadSafe</name>
+ <placement>a</placement>
+ <head>Thread safe:</head>
+ </tag>
+ </tags>
+ </configuration>
+ </plugin>
+ </plugins>
+ </pluginManagement>
  <plugins>
  <plugin>
  <groupId>org.apache.maven.plugins</groupId>
@@ -185,6 +219,11 @@
  </dependencies>
  <reporting>
  <plugins>
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-javadoc-plugin</artifactId>
+ <version>${plugin.maven-javadoc-plugin.version}</version>
+ </plugin>
  <plugin>
  <groupId>org.apache.maven.plugins</groupId>
  <artifactId>maven-changes-plugin</artifactId>

diff --git a/src/main/java/org/codehaus/mojo/taglist/tags/GenericTag.java b/src/main/java/org/codehaus/mojo/taglist/tags/GenericTag.java
@@ -29,11 +29,11 @@
  * 
  * Example POM:
  * <pre>
- * <project >
+ * &lt;project &gt;
  * ...
- * <matchString>fixme</matchString>
+ * &lt;matchString&gt;fixme&lt;/matchString&gt;
  * ...
- * </project>
+ * &lt;/project&gt;
  * </pre>
  * 
  * Example Java code with match:

diff --git a/src/main/java/org/codehaus/mojo/taglist/tags/IgnoreCaseTag.java b/src/main/java/org/codehaus/mojo/taglist/tags/IgnoreCaseTag.java
@@ -29,12 +29,12 @@
  * 
  * Example POM:
  * <pre>
- * <project >
+ * &lt;project&gt;
  * ...
- * <matchString>fixme</matchString>
- * <matchType>ignoreCase</matchType>
+ * &lt;matchString&gt;fixme&lt;/matchString&gt;
+ *  &lt;matchType&gt;ignoreCase&lt;/matchType&gt;
  * ...
- * </project>
+ * &lt;/project&gt;
  * </pre>
  * 
  * Example Java code with match:

diff --git a/src/main/java/org/codehaus/mojo/taglist/tags/RegExTag.java b/src/main/java/org/codehaus/mojo/taglist/tags/RegExTag.java
@@ -31,12 +31,12 @@
  * 
  * Example POM:
  * <pre>
- * <project >
+ * &lt;project&gt;
  * ...
- * <matchString>fixme[0-9]</matchString>
- * <matchType>regEx</matchType>
+ * &lt;matchString&gt;fixme[0-9]&lt;/matchString&gt;
+ *  &lt;matchType&gt;regEx&lt;/matchType&gt;
  * ...
- * </project>
+ * &lt;/project&gt;
  * </pre>
  * 
  * Example Java code with match:

diff --git a/src/main/java/org/codehaus/mojo/taglist/tags/TagClass.java b/src/main/java/org/codehaus/mojo/taglist/tags/TagClass.java
@@ -35,15 +35,15 @@
  * 
  * Example
  * <pre>
- * <tagClass>
- * <displayName>Action Items</displayName>
- * <tags>
- * <tag>
- * <matchString>todo</matchString>
- * <matchType>ignoreCase</matchType>
- * </tag>
- * </tags>
- * </tagClass>
+ * &lt;tagClass&gt;
+ * &lt;displayName&gt;Action Items&lt;/displayName&gt;
+ * &lt;tags&gt;
+ * &lt;tag&gt;
+ * &lt;matchString&gt;todo&lt;/matchString&gt;
+ * &lt;matchType&gt;ignoreCase&lt;/matchType&gt;
+ * &lt;/tag&gt;
+ * &lt;/tags&gt;
+ * &lt;/tagClass&gt;
  * </pre>
  * 
  */

diff --git a/src/test/java/org/codehaus/mojo/taglist/TaglistMojoTagsTest.java b/src/test/java/org/codehaus/mojo/taglist/TaglistMojoTagsTest.java
@@ -179,7 +179,7 @@ public void testJavaDocMultiTags()
  /**
  * Test the tags not at start of line.
  *
- * E.g. // This is a comment about @todo line. <-- @todo didn't start line
+ * E.g. // This is a comment about @todo line. &lt;-- @todo didn't start line
  *
  * @throws Exception
  */