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

since value of a mojo parameter missing in plugin.xml #63

Open
ppalaga opened this issue Jan 2, 2018 · 2 comments
Open

since value of a mojo parameter missing in plugin.xml #63

ppalaga opened this issue Jan 2, 2018 · 2 comments

Comments

@ppalaga
Copy link

ppalaga commented Jan 2, 2018

Given the following Java source of a parameter

    /**
     * If {@code true} the execution of the Mojo will be skipped; otherwise the Mojo will be executed.
     *
     * @since 0.0.1
     */
    @Parameter(property = "editorconfig.skip", defaultValue = "false")
    private boolean skip;

the PluginDescriptorMojo produces the following fragment in plugin.xml:

        <parameter>
          <name>skip</name>
          <type>boolean</type>
          <required>false</required>
          <editable>true</editable>
          <description>If {@code true} the execution of the Mojo will be skipped; otherwise the Mojo will be executed.

 @since 0.0.1</description>
        </parameter>

Note that @since 0.0.1 is a part of <description> (which should not be the case) and <since> tag is missing (expected: present).

I guess the same holds for @deprecated

@ppalaga
Copy link
Author

ppalaga commented Jan 2, 2018

I figured this out after I built a plugin site using maven-plugin-plugin patched with apache/maven-plugin-tools#10

@ifedorenko
Copy link
Contributor

This is a know limitation https://github.com/takari/takari-lifecycle/blob/takari-lifecycle-1.13.3/takari-lifecycle-plugin/src/main/java/io/takari/maven/plugins/plugin/MojoDescriptorGleaner.java#L42 . The fix requires javadoc parsing, something annotation processing API does not support.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants