commons-issues mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Bruno P. Kinoshita (JIRA)" <j...@apache.org>
Subject [jira] [Commented] (LANG-1094) Javadoc is not encoding spaces correctly
Date Wed, 12 Oct 2016 10:06:20 GMT

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

Bruno P. Kinoshita commented on LANG-1094:
------------------------------------------

Hmmm, interesting. Just tried `mvn javadoc:javadoc` for [lang] master branch in my local environment,
and the links now seem to be slightly different.

{noformat}
file:///....../commons-lang/target/site/apidocs/org/apache/commons/lang3/time/DateUtils.html#isSameDay-java.util.Calendar-java.util.Calendar-
{noformat}

So now links contain the arguments separated by a single dash. Couldn't find any reference
to this change in Java 8 release notes.

Could someone else try it as well, please? If someone else confirms it is working now, I can
try to chase the change in JDK.

{noformat}
$ java -version
java version "1.8.0_101"
Java(TM) SE Runtime Environment (build 1.8.0_101-b13)
Java HotSpot(TM) 64-Bit Server VM (build 25.101-b13, mixed mode)
{noformat}

> Javadoc is not encoding spaces correctly
> ----------------------------------------
>
>                 Key: LANG-1094
>                 URL: https://issues.apache.org/jira/browse/LANG-1094
>             Project: Commons Lang
>          Issue Type: Bug
>          Components: General
>            Reporter: Duncan Jones
>            Priority: Minor
>
> I've noticed the Javadocs include links to methods with spaces incorrectly encoded. For
example, the Javadocs for [DateUtils|http://commons.apache.org/proper/commons-lang/javadocs/api-release/org/apache/commons/lang3/time/DateUtils.html]
describes a method:
> {code:java}
> public static boolean isSameDay(Calendar cal1, Calendar cal2)
> {code}
> The link to this is:
> {noformat}
> [...]/DateUtils.html#isSameDay(java.util.Calendar, java.util.Calendar)
> {noformat}
> whereas it should be:
> {noformat}
> [...]/DateUtils.html#isSameDay(java.util.Calendar,%20java.util.Calendar)
> {noformat}
> Not sure what's causing this problem. But it certainly hinders efforts to link to our
docs from other sites (like Stack Overflow).



--
This message was sent by Atlassian JIRA
(v6.3.4#6332)

Mime
View raw message