[MSITE-646] Brackets not working when generating links using site plugin

• Type: Bug
• Status: Closed
• Priority: Major
• Resolution: Not A Problem

Environment

MacOSX Lion 64 bit

java version "1.6.0_33"
Java(TM) SE Runtime Environment (build 1.6.0_33-b03-424-11M3720)
Java HotSpot(TM) 64-Bit Server VM (build 20.8-b03-424, mixed mode)

Apache Maven 3.0.3 (r1075438; 2011-02-28 09:31:09-0800)
Maven home: /usr/share/java/maven-3.0.3
Java version: 1.6.0_33, vendor: Apple Inc.
Java home: /System/Library/Java/JavaVirtualMachines/1.6.0.jdk/Contents/Home
Default locale: en_US, platform encoding: MacRoman
OS name: "mac os x", version: "10.7.4", arch: "x86_64", family: "mac"

• Assignee: Unassigned
• Reporter: Liviu Tudor
• Created: 23/Jul/12 17:49
• Updated: 23/Oct/12 05:30
• Resolved: 26/Jul/12 15:01

Description

This was discovered together with Simone Tripodi when dealing with the Apache Commons Functor project (http://commons.apache.org/functor/): I've put together the attached file which include some links to the javadoc section of the site (generated using maven site plugin).
Some links are links to the classes/interfaces or packages – and these work. Example:

 <a href="apidocs/org/apache/commons/functor/aggregator/ArrayListBackedAggregator.html">ArrayListBackedAggregator</a>

However, where the link is meant to be a link to the method javadoc directly, and as such it includes brackets, the brackets are lost it the process of generating the html. Example:

<a href="apidocs/org/apache/commons/functor/aggregator/AbstractListBackedAggregator.html#createList()">createList()</a>

generates (you can see this on the live site here http://commons.apache.org/functor/aggregator.html):

<a href="apidocs/org/apache/commons/functor/aggregator/AbstractListBackedAggregator.html#createList">createList()</a>

Same happens if the method has parameters:

<a href="apidocs/org/apache/commons/functor/aggregator/Aggregator.html#add(T)">add()</a>

generates

<a href="apidocs/org/apache/commons/functor/aggregator/Aggregator.html#addT">add()</a>

I am attaching the original xml file to this. I use a Mac but I believe Simo uses a Linux – so it's not something to do with encoding I don't think. (As a side note we have actually changed various encoding settings to get the same result.)

Please let me know if there is anything else we need to provide you with.
Kind regards,

Liv

Issue Links

• depends upon: DOXIA-397 Cannot link to javadoc methods
• is superceded by: MSITE-660 CLONE - Brackets not working when generating links using site plugin