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 Thu, 20 Dec 2012 00:07:14 GMT

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

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

Hi Liviu, 

I reverted the changes from FUNCTOR-23.patch. The %23 was breaking the URL's in Chrome 23.0.1271.97/Linux-amd64
and not really fixing the javadoc links.

The patch FUNCTOR-23.2.patch is not necessary anymore, as this issue happens in other components
due to a known bug in Doxia, and using the project website in the links wouldn't allow to
generate the site offline.

But the FUNCTOR-23.2 patch also added a link to aggregators in the top menu. As the top menu
has no links to functors, functions, predicates, procedures or other basic concepts in [functor]
at the moment, it wouldn't be right to include a link to aggregators in there IMHO. 

I added a link to aggregators in the examples page though (r1424226), as there were links
to functions, predicates, procedures and generators already.

Thanks for the hard work on [functor]! Looking forward to more patches :-)

                
> 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