not needed and will hit API limit in GH actions

Most tests still use the old tags format, which was deprecated in 2.x and removed in 3.0.

I'm using v3.0.0 on a multimodule maven project. One module is a war. I have goth java sources in src/main/java and web stuff in src/main/webapp. Taglist processes the java code just fine but ignores the src/main/webapp. I'd like to include TODO statements in javascript, jsp, css, html etc.

i setup the config element with this

<configuration>
   <includes>**/*.java</includes>
   <includes>**/*.js</includes>
   <includes>**/*.jsp</includes>

I'm not entirely sure this is right as there aren't any examples on the website but i think it's in the ballpark after looking that the mojo. Is there any configuration magic i can set to get these additional files included?

update to mojo-parent version 37

This will generate a report with an old version of the taglist-maven-plugin, not with "self".
This does not fix the problem for other plugins or projects, only for this very plugin itself (hence only documentation as it is only visible on its own site).

Currently the site generation only works with Maven 2.2.1

I couldn't find any option to exclude a java source file from checking the tags. Do we have an option already in the plugin? If yes can anyone please share how to do it?

Usually we don't want to exclude any sources from static analysis but some sources are generated by code generator tools which may document tags based on the input template for those tools.

If not can this be added, probably i can contribute.

Request to have an optional priority added to tags in the configuration. This way aggregation done on the taglist.xml output could be done, as well as matching how some IDEs (eclipse) allow tags to be classified as high, medium, or low.

So if enabled, result would be, in example:

<tag name="TODO" count="3" priority="high" />

From #24 to fix this warning

[WARNING] javadoc: warning - The code being documented uses modules but the packages defined in https://docs.oracle.com/javase/8/docs/api/ are in the unnamed module.

Happens when compiling with Java 9+.
Either don't use source and target (impossible due to parent) or define source again for the javadoc plugin, or define release (only when compiling with 11+).

I would like to be able to create tag lists for mixed java/scala projects.

Please see the pull request here: #11

Thanks in advance!

First attempt using this and i'm getting the following warning

Could not open/create prefs root node Software/JavaSoft/Prefs at root 0x80000002. Windows.RegCreateKeyEx(...) returns error code 5

Hi there! I just had a case to use the plugin (thank you, BTW, as I've used it several times in the past) and spent close to 2 hours trying to incorporate FIXMEs. My memory told me that it was just a tag. I then found something like this on the Usage page:

For backwards compatibility with versions prior to the 2.4 release, the legacy tags configuration is supported; however, only exact matching is used with legacy configuration.

    <project>
      ...
            <configuration>
              <tags>
                <tag>TODO</tag>
                <tag>FIXME</tag>
                <tag>@todo</tag>
                <tag>@deprecated</tag>
              </tags>
            </configuration>
      ...
    </project>

Small typo: "backwards" -> "backward".
Missing article: "with legacy" "with the legacy"

True problem

The usage page config doesn't seem to be working. I mean here the legacy config with a new version of the plugin.

I've created a dummy project for this and:

In a nutshell:

1. plugin in build, version 3.0.0, config mentions FIXME, mvn taglist:taglist does NOT pick up FIXME is the new kid on the block. TODOs are being sought.
2. same with reporting
3. downgrade to 2.3 and the config works.
4. there's no message, other than "using legacy tag" warning.

What I'd expect:

1. usage page suggests this works. Please either make it so or clarify that version needs to be downgraded for it to work.
2. clearly mark that it's no longer REPORTING but BUILD, unless it's the site command. This I did not tests. I'm however certain, that adding a line or two about BUILD being the target section for mvn taglist:taglist would be to overall benefit.

Hi!!!

If you use the plugin along with maven site plugin version 4.0.0-M8, the table is not shown correctly.

It would be great to fix it.

Lot of thanks!!!

The Plexus/Maven method FileUtils::getFiles declares an IOException, which cannot be thrown in canGenerateReport, which is most unfortunate.

Currently the code checks the language of each project when running in aggregator mode:

• taglist-maven-plugin/src/main/java/org/codehaus/mojo/taglist/TagListReport.java

  Line 488 in 82ffe28

  if ( "java".equals( reactorProject.getArtifact().getArtifactHandler().getLanguage() ) )

Now that non Java files are supported this check needs to be replaced (packaging != pom for example) or removed.

From #24

[WARNING] [APT Parser] Ambiguous link: 'usage.html'. If this is a local link, prepend "./"!
[WARNING] Could not parse date '24 March 2007' from index.apt (expected yyyy-MM-dd format), ignoring!
[WARNING] [APT Parser] Ambiguous link: 'taglist-mojo.html'. If this is a local link, prepend "./"!

(also add "code quality" label to the release bot)

• Add generics
• Remove manual (un)boxing
• Convert iterators to enhanced for loops
• try-with-resources
• Remove redundant initializers for fields.
• Mark fields as final
• Remove .sort( collection ) calls, replace with sorted collection.
• add code quality label to release bot

Since a TagClass must have at least one tag to be considered for search, make the displayName field optional.
If it is null, just use the first tag.

Hint: This might be a regex string

Hello!

We use maven linkcheck plugin to check links on checkstyle's website: http://checkstyle.sourceforge.net/ . The plugin reports that on page http://checkstyle.sourceforge.net/plugins.html the following link is redirected:
http://mojo.codehaus.org/taglist-maven-plugin (302 Found) at http://www.mojohaus.org .

Links on plugins.html are generated by Apache Maven Project Info Reports Plugin. All URLs are grabbed from effective POMs of plugins.

Here is the code:

https://github.com/apache/maven-plugins/blob/trunk/maven-project-info-reports-plugin/src/main/java/org/apache/maven/report/projectinfo/PluginsReport.java#L239

https://github.com/apache/maven-plugins/blob/trunk/maven-project-info-reports-plugin/src/main/java/org/apache/maven/report/projectinfo/PluginsReport.java#L269

In effective POM.xml of maven taglist plugin the problematic link is:
http://mojo.codehaus.org/taglist-maven-plugin

As a result, we do not have an ability to change plugins urls on that page, because those links are specified by plugins developers.

So, please correct the link, because there are contradictions between linkcheck and maven taglist plugin.

Thank in advance!

Is there a way to aggregate the list on a multiple module project? or at least have a summary table for the parent module that links to the child module?

From #24

[INFO] --- maven-plugin-plugin:3.6.0:descriptor (default) @ taglist-maven-plugin ---
[INFO] Using 'UTF-8' encoding to read mojo source files.
[WARNING] org.codehaus.mojo.taglist.TagListReport#aggregate:
[WARNING]   The syntax
[WARNING]     @parameter expression="${property}"
[WARNING]   is deprecated, please use
[WARNING]     @parameter property="property"
[WARNING]   instead.
[WARNING] org.codehaus.mojo.taglist.TagListReport#encoding:
[WARNING]   The syntax
[WARNING]     @parameter expression="${property}"
[WARNING]   is deprecated, please use
[WARNING]     @parameter property="property"
[WARNING]   instead.
[WARNING] org.codehaus.mojo.taglist.TagListReport#linkXRef:
[WARNING]   The syntax
[WARNING]     @parameter expression="${property}"
[WARNING]   is deprecated, please use
[WARNING]     @parameter property="property"
[WARNING]   instead.
[WARNING] org.codehaus.mojo.taglist.TagListReport#project:
[WARNING]   The syntax
[WARNING]     @parameter expression="${property}"
[WARNING]   is deprecated, please use
[WARNING]     @parameter property="property"
[WARNING]   instead.
[WARNING] org.codehaus.mojo.taglist.TagListReport#reactorProjects:
[WARNING]   The syntax
[WARNING]     @parameter expression="${property}"
[WARNING]   is deprecated, please use
[WARNING]     @parameter property="property"
[WARNING]   instead.

./mvnw taglist:taglist

gives [WARNING] Using legacy tag format. This is not recommended.

What is it referring to: something in the plugin configuration or something in my code?

We might want to change this default value:

Git tag is created, website is updated, but cannot find here: https://repo1.maven.org/maven2/org/codehaus/mojo/taglist-maven-plugin/
I need it for an upcoming MSITE/MJAVADOC update to fix issues with Doxia. I also don't have access ot the staging repos on oss.s.o, but that's another story.

Hi and thank you for the plugin. I use it every now and then, and each time I spend a LOT of time figuring out what happened with FIXME comments and why they're gone/unaccounted for. Prior to 2.4 they were in or were easy to add.

Would you mind changing the empty tag list to contain both TODO and FIXME?

It would suffice to add "FIXME" to this line:

Hello team,

This is my first issue in this repo.
If nothing else, wanted to say big thanks for this project.

When running this as part of mvn site command, I am seeing this:

[INFO] Generating "Tag List" report      --- taglist-maven-plugin:3.0.0:taglist
[WARNING] Using legacy tag format.  This is not recommended.

The thing is, I have no tag at all in my code.
How do I fix this warning please?
i.e, how do I not use legacy format?

Thank you