Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Parse javadoc tags in xdoc generator (only @since is supported atm) #414

Merged
merged 2 commits into from
Feb 17, 2024

Conversation

gnodet
Copy link
Member

@gnodet gnodet commented Feb 2, 2024

This fixes new javadoc syntax:
image
instead of
image

and adds support for @since tag:
image
instead of
image

We may want to add support for more javadoc tags, but not sure which ones are used. For example the @see tag may be used, but we don't have any way to point to the actual target. All other tags (other than @since) are currently discarded.

@gnodet gnodet marked this pull request as ready for review February 5, 2024 10:24
@hboutemy
Copy link
Member

hboutemy commented Feb 7, 2024

based on recent updates in some .mdo, shouldnt' also @see and {@code xxx} be necessary?

@gnodet
Copy link
Member Author

gnodet commented Feb 8, 2024

based on recent updates in some .mdo, shouldnt' also @see and {@code xxx} be necessary?

In the screen capture, you can see there's a {@code xxx} block already, so that part is covered.
For the @see, I don't think we can generate a link in the xdoc. That's why I left it out, but we could generate something like the output of @since without the link though... ?

@hboutemy ?

@gnodet gnodet added this to the 2.2.0 milestone Feb 17, 2024
@gnodet gnodet merged commit 1ca6d58 into codehaus-plexus:master Feb 17, 2024
13 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants