commons-issues mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "ASF GitHub Bot (JIRA)" <j...@apache.org>
Subject [jira] [Commented] (LANG-1314) javadoc creation broken with Java 8
Date Sun, 05 Mar 2017 16:13:32 GMT

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

ASF GitHub Bot commented on LANG-1314:
--------------------------------------

GitHub user mureinik opened a pull request:

    https://github.com/apache/commons-lang/pull/252

    [LANG-1314] Fix javadoc creation on with Java 8

    Java 8's javadoc seems to be stricter than Java 7's, and the current head current fails
to generate javadoc (`mvn javadoc:javadoc`) with Java 8.
    
    This PR contains a series of fixes to the various classes' javadoc which are required
for Java 8 (but would also improve the javadoc generated with earlier java versions) and then
adds the `javadoc:javadoc` target to Travis CI so we can guarantee it won't break again.

You can merge this pull request into a Git repository by running:

    $ git pull https://github.com/mureinik/commons-lang javadoc

Alternatively you can review and apply these changes as the patch at:

    https://github.com/apache/commons-lang/pull/252.patch

To close this pull request, make a commit to your master/trunk branch
with (at least) the following in the commit message:

    This closes #252
    
----
commit 972d29447d115224674154e0150d51bf9ccf6524
Author: Allon Mureinik <amureini@redhat.com>
Date:   2017-03-05T09:50:34Z

    Add @param for <T> in ArrayUtils#insert

commit e4147a700f6c49b954a6f91dc8f2f1499777e92c
Author: Allon Mureinik <amureini@redhat.com>
Date:   2017-03-05T09:53:33Z

    Fix StirngUtils </p> tags in javadoc
    
    The paragraph
    
    </p>Whitespace is defined by {@link Character#isWhitespace(char)}.</p>
    
    appears in several places in the javadoc (presumably, copy-pasted from
    the original one to the others). This is obviously a mistake, as a
    paragraph should start with <p>, not with </p>.
    
    This patch fixes all the occurrences of this paragraph to the proper
    form:
    
    <p>Whitespace is defined by {@link Character#isWhitespace(char)}.</p>

commit 54eff5e8a55f591c1ae3fe31fd04dce663bbe4e1
Author: Allon Mureinik <amureini@redhat.com>
Date:   2017-03-05T09:56:05Z

    Remove </p> tag from Computable's javadoc
    
    The standard javadoc doclet does not allow self closing tags (such as
    </p>). This patch removes such a tag from Computable's javadoc, as it's
    redundant anyway, as it's only used to create spaces between two
    existing paragraphs.

commit 632431f9433ce228407218dabef7b00fa8464ef4
Author: Allon Mureinik <amureini@redhat.com>
Date:   2017-03-05T16:03:01Z

    Add javadoc creation to Travis CI

----


> javadoc creation broken with Java 8
> -----------------------------------
>
>                 Key: LANG-1314
>                 URL: https://issues.apache.org/jira/browse/LANG-1314
>             Project: Commons Lang
>          Issue Type: Bug
>          Components: General
>         Environment: amureini@mureinik ~ $ mvn -version
> Apache Maven 3.3.9 (NON-CANONICAL_2016-07-01T11:53:38Z_mockbuild; 2016-07-01T14:53:38+03:00)
> Maven home: /usr/share/maven
> Java version: 1.8.0_121, vendor: Oracle Corporation
> Java home: /usr/lib/jvm/java-1.8.0-openjdk-1.8.0.121-1.b14.fc25.x86_64/jre
> Default locale: en_US, platform encoding: UTF-8
> OS name: "linux", version: "4.9.12-200.fc25.x86_64", arch: "amd64", family: "unix"
>            Reporter: Allon Mureinik
>            Priority: Minor
>
> Java 8's javadoc seems to be stricter than the Java 7 one. With the current HEAD (commit
e5ed4ff), mvn javadoc:javadoc passes with Java 7, but fails on the same machine with Java
8 (environment described above) with the following errors:
> [ERROR] Failed to execute goal org.apache.maven.plugins:maven-javadoc-plugin:2.10.4:javadoc
(default-cli) on project commons-lang3: An error has occurred in JavaDocs report generation:
> [ERROR] Exit code: 1 - /home/amureini/src/git/commons-lang/src/main/java/org/apache/commons/lang3/ArrayUtils.java:8421:
warning: no @param for <T>
> [ERROR] public static <T> T[] insert(final int index, final T[] array, final T...
values) {
> [ERROR] ^
> [ERROR] /home/amureini/src/git/commons-lang/src/main/java/org/apache/commons/lang3/StringUtils.java:316:
error: unexpected end tag: </p>
> [ERROR] * </p>Whitespace is defined by {@link Character#isWhitespace(char)}.</p>
> [ERROR] ^
> [ERROR] /home/amureini/src/git/commons-lang/src/main/java/org/apache/commons/lang3/StringUtils.java:316:
error: unexpected end tag: </p>
> [ERROR] * </p>Whitespace is defined by {@link Character#isWhitespace(char)}.</p>
> [ERROR] ^
> [ERROR] /home/amureini/src/git/commons-lang/src/main/java/org/apache/commons/lang3/StringUtils.java:347:
error: unexpected end tag: </p>
> [ERROR] * </p>Whitespace is defined by {@link Character#isWhitespace(char)}.</p>
> [ERROR] ^
> [ERROR] /home/amureini/src/git/commons-lang/src/main/java/org/apache/commons/lang3/StringUtils.java:347:
error: unexpected end tag: </p>
> [ERROR] * </p>Whitespace is defined by {@link Character#isWhitespace(char)}.</p>
> [ERROR] ^
> [ERROR] /home/amureini/src/git/commons-lang/src/main/java/org/apache/commons/lang3/StringUtils.java:370:
error: unexpected end tag: </p>
> [ERROR] * </p>Whitespace is defined by {@link Character#isWhitespace(char)}.</p>
> [ERROR] ^
> [ERROR] /home/amureini/src/git/commons-lang/src/main/java/org/apache/commons/lang3/StringUtils.java:370:
error: unexpected end tag: </p>
> [ERROR] * </p>Whitespace is defined by {@link Character#isWhitespace(char)}.</p>
> [ERROR] ^
> [ERROR] /home/amureini/src/git/commons-lang/src/main/java/org/apache/commons/lang3/StringUtils.java:403:
error: unexpected end tag: </p>
> [ERROR] * </p>Whitespace is defined by {@link Character#isWhitespace(char)}.</p>
> [ERROR] ^
> [ERROR] /home/amureini/src/git/commons-lang/src/main/java/org/apache/commons/lang3/StringUtils.java:403:
error: unexpected end tag: </p>
> [ERROR] * </p>Whitespace is defined by {@link Character#isWhitespace(char)}.</p>
> [ERROR] ^
> [ERROR] /home/amureini/src/git/commons-lang/src/main/java/org/apache/commons/lang3/StringUtils.java:436:
error: unexpected end tag: </p>
> [ERROR] * </p>Whitespace is defined by {@link Character#isWhitespace(char)}.</p>
> [ERROR] ^
> [ERROR] /home/amureini/src/git/commons-lang/src/main/java/org/apache/commons/lang3/StringUtils.java:436:
error: unexpected end tag: </p>
> [ERROR] * </p>Whitespace is defined by {@link Character#isWhitespace(char)}.</p>
> [ERROR] ^
> [ERROR] /home/amureini/src/git/commons-lang/src/main/java/org/apache/commons/lang3/StringUtils.java:1946:
error: unexpected end tag: </p>
> [ERROR] * </p>Whitespace is defined by {@link Character#isWhitespace(char)}.</p>
> [ERROR] ^
> [ERROR] /home/amureini/src/git/commons-lang/src/main/java/org/apache/commons/lang3/StringUtils.java:1946:
error: unexpected end tag: </p>
> [ERROR] * </p>Whitespace is defined by {@link Character#isWhitespace(char)}.</p>
> [ERROR] ^
> [ERROR] /home/amureini/src/git/commons-lang/src/main/java/org/apache/commons/lang3/StringUtils.java:7092:
error: unexpected end tag: </p>
> [ERROR] * </p>Whitespace is defined by {@link Character#isWhitespace(char)}.</p>
> [ERROR] ^
> [ERROR] /home/amureini/src/git/commons-lang/src/main/java/org/apache/commons/lang3/StringUtils.java:7092:
error: unexpected end tag: </p>
> [ERROR] * </p>Whitespace is defined by {@link Character#isWhitespace(char)}.</p>
> [ERROR] ^
> [ERROR] /home/amureini/src/git/commons-lang/src/main/java/org/apache/commons/lang3/StringUtils.java:7241:
error: unexpected end tag: </p>
> [ERROR] * </p>Whitespace is defined by {@link Character#isWhitespace(char)}.</p>
> [ERROR] ^
> [ERROR] /home/amureini/src/git/commons-lang/src/main/java/org/apache/commons/lang3/StringUtils.java:7241:
error: unexpected end tag: </p>
> [ERROR] * </p>Whitespace is defined by {@link Character#isWhitespace(char)}.</p>
> [ERROR] ^
> [ERROR] /home/amureini/src/git/commons-lang/src/main/java/org/apache/commons/lang3/concurrent/Computable.java:21:
error: self-closing element not allowed
> [ERROR] * <p/>
> [ERROR] ^
> [ERROR] /home/amureini/src/git/commons-lang/src/main/java/org/apache/commons/lang3/concurrent/Computable.java:21:
warning: empty <p> tag
> [ERROR] * <p/>
> [ERROR] ^



--
This message was sent by Atlassian JIRA
(v6.3.15#6346)

Mime
View raw message