You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@maven.apache.org by "Christoph Lembeck (JIRA)" <ji...@apache.org> on 2017/08/23 09:03:00 UTC

[jira] [Commented] (MPLUGIN-324) javadoc generated by helpmojo goal of maven-plugin-plugin produces build failures

    [ https://issues.apache.org/jira/browse/MPLUGIN-324?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16138105#comment-16138105 ] 

Christoph Lembeck commented on MPLUGIN-324:
-------------------------------------------

The javadoc-plugin only fails, if yo configure it to show the private members too:
{code}
<plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-javadoc-plugin</artifactId>
                <configuration>
                    <show>private</show>
                </configuration>
                <executions>
                    <execution>
                        <id>attach-javadocs</id>
                        <goals>
                            <goal>jar</goal>
                        </goals>
                    </execution>
                </executions>
            </plugin>
{code}

> javadoc generated by helpmojo goal of maven-plugin-plugin produces build failures
> ---------------------------------------------------------------------------------
>
>                 Key: MPLUGIN-324
>                 URL: https://issues.apache.org/jira/browse/MPLUGIN-324
>             Project: Maven Plugin Tools
>          Issue Type: Bug
>          Components: Plugin Plugin
>    Affects Versions: 3.5
>         Environment: Apache Maven 3.5.0 (ff8f5e7444045639af65f6095c62210b5713f426; 2017-04-03T21:39:06+02:00)
> OS name: "windows 7", version: "6.1", arch: "x86", family: "windows"
> Java version: 1.8.0_131, vendor: Oracle Corporation
>            Reporter: Christoph Lembeck
>
> In our project we use the {{helpmojo}} goal of the {{maven-plugin-plugin}} to generate a HelpMojo class.
> Unfortunately the maven-javadoc-plugin fails to process that generated file because the generated javadoc comments contain the illegal symbol '{{<}}'.
> Here is the error message:
> {code}
> [ERROR] Failed to execute goal org.apache.maven.plugins:maven-javadoc-plugin:3.0.0-M1:jar (attach-javadocs) on project codegen-maven-plugin: MavenReportException: Error while generating Javadoc:
> [ERROR] Exit code: 1 - D:\eclipse\codegen\codegen-maven-plugin\target\generated-sources\plugin\de\chrlembeck\codegen\HelpMojo.java:354: error: malformed HTML
> [ERROR]      * @throws NegativeArraySizeException if <code>indent < 0</code>
> [ERROR]                                                           ^
> {code}
> And this is the generated output, that fails:
> {code}
>     /**
>      * Splits the specified text into lines of convenient display length.
>      *
>      * @param text       The text to split into lines, must not be <code>null</code>.
>      * @param indent     The base indentation level of each line, must not be negative.
>      * @param indentSize The size of each indentation, must not be negative.
>      * @param lineLength The length of the line, must not be negative.
>      * @return The sequence of display lines, never <code>null</code>.
>      * @throws NegativeArraySizeException if <code>indent < 0</code>
>      */
>     private static List<String> toLines( String text, int indent, int indentSize, int lineLength )
> {code}



--
This message was sent by Atlassian JIRA
(v6.4.14#64029)