commons-issues mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From mureinik <...@git.apache.org>
Subject [GitHub] commons-lang pull request #252: [LANG-1314] Fix javadoc creation on with Jav...
Date Sun, 05 Mar 2017 16:12:35 GMT
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

----


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---

Mime
View raw message