commons-issues mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Sebb (JIRA)" <j...@apache.org>
Subject [jira] [Commented] (FUNCTOR-23) aggregator.xml generates broken JavaDoc links
Date Sat, 20 Oct 2012 11:40:13 GMT

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

Sebb commented on FUNCTOR-23:
-----------------------------

bq. I think we should use the initial approach

Agreed. Although it would be better if the link took one directly to the method, using absolute
links is a worse problem.


Note: there is a fix for some Doxia relativisation errors in the commons-site VM file.
The VM file just removes 'http://dummy.invalid/' from the start of any link text.
However it does not currently process the main text body though it should not be too difficult
to extend the code to do so. If that were done, then one could prefix any Javadoc method links
with 'http://dummy.invalid/' to skip the Doxia mangling.
                
> 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