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] (FUNCTOR-23) aggregator.xml generates broken JavaDoc links
Date Sat, 20 Oct 2012 03:28:12 GMT

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

Bruno P. Kinoshita commented on FUNCTOR-23:
-------------------------------------------

Hi Liviu, 

The problem with absolute links is that if you are working offline, you won't be able to generate
the site and browse the links (as you would be directed to http://commons.apache.org/functor,
rather than file://...).

I took a look at the Doxia issues and seems like it hasn't been solved yet. I tried using
Markdown, but the same happens. No lucky trying escape the () too.

I think we should use the initial approach (i.e.: apidocs/org/apache/.../Class.html#method())
even if the () gets cut due to a bug in Doxia. Other components like Apache Commons Math [1]
and Apache Commons VFS [2] use this too.

[1] http://commons.apache.org/math/userguide/genetics.html
[2] http://commons.apache.org/vfs/api.html
                
> aggregator.xml generates broken JavaDoc links
> ---------------------------------------------
>
>                 Key: FUNCTOR-23
>                 URL: https://issues.apache.org/jira/browse/FUNCTOR-23
>             Project: Commons Functor
>          Issue Type: Bug
>            Reporter: Liviu Tudor
>            Assignee: Simone Tripodi
>            Priority: Trivial
>              Labels: site
>         Attachments: FUNCTOR-23.2.patch.bz2, FUNCTOR-23.patch.bz2
>
>
> {{aggregator.xml}} has a few JavaDoc links to methods, as such the anchor url contains
a hash (#) as well as a method name followed by brackets (). This triggers Doxia/Velocity
into "thinking" that this is a macro call, and as such the links resulted (during {{mvn site}})
do not contain these brackets.
> To fix them, as per https://jira.codehaus.org/browse/MSITE-646, we need to URL-escape
the # hash sign (%23).
> This bug is created to propose a patch to {{aggregator.xml}} for this.

--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators
For more information on JIRA, see: http://www.atlassian.com/software/jira

Mime
View raw message