You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@maven.apache.org by "slawekjaranowski (via GitHub)" <gi...@apache.org> on 2026/03/01 14:50:22 UTC
[I] Replace or drop using of qdox [maven-plugin-tools]
slawekjaranowski opened a new issue, #1080:
URL: https://github.com/apache/maven-plugin-tools/issues/1080
### New feature, improvement proposal
As [qdox](https://github.com/paul-hammant/qdox) is deprecated and not more maintaned
- https://github.com/paul-hammant/qdox/issues/287
We should find alternative for it, or implement needed code in plugin.
--
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-unsubscribe@maven.apache.org.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [I] Replace or drop using of qdox [maven-plugin-tools]
Posted by "cstamas (via GitHub)" <gi...@apache.org>.
cstamas commented on issue #1080:
URL: https://github.com/apache/maven-plugin-tools/issues/1080#issuecomment-4223844305
Or, consider something like https://github.com/forge/roaster
Is already used in maven-resolver and maven4 for document generation.
--
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-unsubscribe@maven.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [I] Replace or drop using of qdox [maven-plugin-tools]
Posted by "ascopes (via GitHub)" <gi...@apache.org>.
ascopes commented on issue #1080:
URL: https://github.com/apache/maven-plugin-tools/issues/1080#issuecomment-4072994136
I was thinking about this recently and wondered if one option to consider could be replacing the logic that scrapes Mojo classes with an annotation processor that hooks into the Java Compiler.
It appears that the ProcessingEnvironment class within the annotation processing API can provide details on JavaDoc comments decorating annotations, and the Mojo classes themselves are already driven by annotations that could be hooked into.
The `help` Mojo (in theory) could then be generated by collecting some JSON or XML blobs the AP emits that holds the details of each parameter in each Mojo.
Since the Javac implementation also supports the new markdown-style comments (`/// foo`), this could open the ability to support that.
This may also enable being able to generate docs for complex objects that have JavaDoc comments internally as well (at least, if they are in the same project), since that could be interrogated during compilation.
--
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-unsubscribe@maven.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [I] Replace or drop using of qdox [maven-plugin-tools]
Posted by "cstamas (via GitHub)" <gi...@apache.org>.
cstamas commented on issue #1080:
URL: https://github.com/apache/maven-plugin-tools/issues/1080#issuecomment-4223734114
Why not just drop it? qdox was used here to scrape javadoc tags, that predated Java 1.5 annotations, no?
I'd say just drop javadoc tag support, as since Java 1.5 (2004) they should be the default way to code Mojos, and not javadoc tags.
--
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-unsubscribe@maven.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [I] Replace or drop using of qdox [maven-plugin-tools]
Posted by "cstamas (via GitHub)" <gi...@apache.org>.
cstamas commented on issue #1080:
URL: https://github.com/apache/maven-plugin-tools/issues/1080#issuecomment-4223778921
wow, even if qdox is dropped, is pulled in by https://github.com/codehaus-plexus/plexus-languages (java)
--
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-unsubscribe@maven.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [I] Replace or drop using of qdox [maven-plugin-tools]
Posted by "slachiewicz (via GitHub)" <gi...@apache.org>.
slachiewicz commented on issue #1080:
URL: https://github.com/apache/maven-plugin-tools/issues/1080#issuecomment-5639236953
> wow, even if qdox is dropped, is pulled in by https://github.com/codehaus-plexus/plexus-languages (java)
fixed https://github.com/codehaus-plexus/plexus-languages/releases/tag/plexus-languages-1.6.0
--
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-unsubscribe@maven.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [I] Replace or drop using of qdox [maven-plugin-tools]
Posted by "ascopes (via GitHub)" <gi...@apache.org>.
ascopes commented on issue #1080:
URL: https://github.com/apache/maven-plugin-tools/issues/1080#issuecomment-4223698217
I spent some time the other day looking into this and it does seem to be possible. I'm not sure on the exact semantics for how this needs to work though but I did draft the core skeleton of this locally. @slawekjaranowski would this be something of interest for me to contribute, in your opinion? I'd be happy to allocate some time when I am not working to try and contribute this but want to be sure it would be of interest before blindly committing any time to it.
The flow would look something like:
1. annotation processor uses javac APIs to process `@Mojo` annotations (+ `@Parameter`, `@Inject`, `@Component`, `@Execute`, etc).
2. annotation processor scrapes javadoc comments (and MD comments if on JDK23 or newer) for annotated elements. This uses the accessible sun APIs from the JDK. (Question of how this would work for Eclipse as I've had other issues with ECJ in the past unfortunately, but not sure that should be a total blocker for this).
3. annotation processor dumps JSON or XML files to `target/classes` or similar for each Mojo that it processes.
4. new generator in existing codebase scans for generated JSON/XML descriptors of each Mojo to present them back to the plugin descriptor.
--
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-unsubscribe@maven.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [I] Replace or drop using of qdox [maven-plugin-tools]
Posted by "ascopes (via GitHub)" <gi...@apache.org>.
ascopes commented on issue #1080:
URL: https://github.com/apache/maven-plugin-tools/issues/1080#issuecomment-4224050742
@cstamas it seems the new java annotation path still relies on this to work as well unfortunately, which is why I've been blocked by GH-944 since last summer 😔.
From what I can tell, it is also scraping the generic comments for each parameter.
--
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-unsubscribe@maven.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org