You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@maven.apache.org by "Lukas Theussl (JIRA)" <ji...@codehaus.org> on 2010/06/25 12:01:12 UTC

[jira] Created: (DOXIA-397) Cannot link to javadoc methods

Cannot link to javadoc methods
------------------------------

                 Key: DOXIA-397
                 URL: http://jira.codehaus.org/browse/DOXIA-397
             Project: Maven Doxia
          Issue Type: Bug
          Components: Core, Module - Apt, Module - Xdoc
    Affects Versions: 1.1.3
            Reporter: Lukas Theussl


Using a link to a javadoc method like

{noformat}
{{{../apidocs/groovyx/net/http/ParserRegistry.html#parseText(org.apache.http.HttpResponse)}ParserRegistry}}
{noformat}

the apt parser removes the brackets of the anchor. The same thing happens with xdocs and probably other formats. Note that non-ascii characters are not legal in anchor names, but they should be replaced by their hex values, see http://www.w3.org/TR/html401/appendix/notes.html#non-ascii-chars.

-- 
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators: http://jira.codehaus.org/secure/Administrators.jspa
-
For more information on JIRA, see: http://www.atlassian.com/software/jira

        

[jira] Commented: (DOXIA-397) Cannot link to javadoc methods

Posted by "Thom Nichols (JIRA)" <ji...@codehaus.org>.
    [ http://jira.codehaus.org/browse/DOXIA-397?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=226359#action_226359 ] 

Thom Nichols commented on DOXIA-397:
------------------------------------

So you can have a link to a 'local' Doxia ID that's not on the same page?  I assumed local links had to be valid relative URIs.  

It sounds like the proper solution would be to have two link formats - one for URIs and one for Doxia IDs.  Otherwise, how can Doxia tell if this:
{code}
 {{{../apidocs/groovyx/net/http/HTTPBuilder.html#defaultSuccessHandler%28org.apache.http.HttpResponse%2C%20java.lang.Object%29}defaultSuccessHandler}}
{code}
is a Doxia ID or a relative URI?

> Cannot link to javadoc methods
> ------------------------------
>
>                 Key: DOXIA-397
>                 URL: http://jira.codehaus.org/browse/DOXIA-397
>             Project: Maven Doxia
>          Issue Type: Bug
>          Components: Core, Module - Apt, Module - Xdoc
>    Affects Versions: 1.1.3
>            Reporter: Lukas Theussl
>
> Using a link to a javadoc method like
> {noformat}
> {{{../apidocs/groovyx/net/http/ParserRegistry.html#parseText(org.apache.http.HttpResponse)}ParserRegistry}}
> {noformat}
> the apt parser removes the brackets of the anchor. The same thing happens with xdocs and probably other formats. Note that non-ascii characters are not legal in anchor names, but they should be replaced by their hex values, see http://www.w3.org/TR/html401/appendix/notes.html#non-ascii-chars.

-- 
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators: http://jira.codehaus.org/secure/Administrators.jspa
-
For more information on JIRA, see: http://www.atlassian.com/software/jira

        

[jira] Issue Comment Edited: (DOXIA-397) Cannot link to javadoc methods

Posted by "Lukas Theussl (JIRA)" <ji...@codehaus.org>.
    [ http://jira.codehaus.org/browse/DOXIA-397?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=226342#action_226342 ] 

Lukas Theussl edited comment on DOXIA-397 at 6/25/10 9:14 AM:
--------------------------------------------------------------

Not really, this issue has nothing to do with local, internal or external links. These notions only distinguish the case of where the link points to (target within same source document, target within same site, target outside), but in each case the URI has to be valid. Since Doxia 1.1 we fix all invalid ids, that's why the warning is emitted, you are supposed to correct the links in your source documents.

Btw, it should work if you use absolute links, as only local and internal links are re-written. Eg if you link from one apt document to another within your site, you can control both the link (href) and the target (anchor), but if you link to the internet, you usually do not control the target. Unfortunately, javadoc generates invalid anchors, which is apparently a well-known fact: http://mindprod.com/jgloss/javadoc.html#BUGS

      was (Author: lukas):
    Not really, this issue has nothing to do with local, internal or external links. These notions only distinguish the case of where the link points to (target within same source document, target within same site, target outside), but in each case the URI has to be valid. Since Doxia 1.1 we fix all invalid ids, that's why the warning is emitted, you are supposed to correct the links in your source documents.

Btw, it should work if you use absolute links, as only local and internal links are re-written. Eg if you link from one apt document to another within your site, you can control both the link (href) and the target (anchor), but if you link to the internet, you usually do not control the target. Unfortunately, javadoc generates invalid anchors, which is apparently a well-known fact: http://mindprod.com/jgloss/javadoc.html
  
> Cannot link to javadoc methods
> ------------------------------
>
>                 Key: DOXIA-397
>                 URL: http://jira.codehaus.org/browse/DOXIA-397
>             Project: Maven Doxia
>          Issue Type: Bug
>          Components: Core, Module - Apt, Module - Xdoc
>    Affects Versions: 1.1.3
>            Reporter: Lukas Theussl
>
> Using a link to a javadoc method like
> {noformat}
> {{{../apidocs/groovyx/net/http/ParserRegistry.html#parseText(org.apache.http.HttpResponse)}ParserRegistry}}
> {noformat}
> the apt parser removes the brackets of the anchor. The same thing happens with xdocs and probably other formats. Note that non-ascii characters are not legal in anchor names, but they should be replaced by their hex values, see http://www.w3.org/TR/html401/appendix/notes.html#non-ascii-chars.

-- 
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators: http://jira.codehaus.org/secure/Administrators.jspa
-
For more information on JIRA, see: http://www.atlassian.com/software/jira

        

[jira] Commented: (DOXIA-397) Cannot link to javadoc methods

Posted by "Lukas Theussl (JIRA)" <ji...@codehaus.org>.
    [ http://jira.codehaus.org/browse/DOXIA-397?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=257601#action_257601 ] 

Lukas Theussl commented on DOXIA-397:
-------------------------------------

I have added a [test case|http://svn.apache.org/viewvc?rev=1074151&view=rev] that gets broken by the attached patch. I think this is a rather common use case, as mentioned above, fixing this will break a lot of stuff (note that apt does not distinguish anchor names from anchor text, ie something like <a name="name">text</a> is not possible in apt, so there are many examples of anchors like {anchor with spaces}).

I agree it's annoying, but I'd prefer to postpone a fix for this until a major version change. Until then I suggest to use abolute links for javadocs.

> Cannot link to javadoc methods
> ------------------------------
>
>                 Key: DOXIA-397
>                 URL: http://jira.codehaus.org/browse/DOXIA-397
>             Project: Maven Doxia
>          Issue Type: Bug
>          Components: Core, Module - Apt, Module - Xdoc
>    Affects Versions: 1.1.3
>            Reporter: Lukas Theussl
>         Attachments: apt-link-fix.diff
>
>
> Using a link to a javadoc method like
> {noformat}
> {{{../apidocs/groovyx/net/http/ParserRegistry.html#parseText(org.apache.http.HttpResponse)}ParserRegistry}}
> {noformat}
> the apt parser removes the brackets of the anchor. The same thing happens with xdocs and probably other formats. Note that non-ascii characters are not legal in anchor names, but they should be replaced by their hex values, see http://www.w3.org/TR/html401/appendix/notes.html#non-ascii-chars.

-- 
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators: http://jira.codehaus.org/secure/Administrators.jspa
-
For more information on JIRA, see: http://www.atlassian.com/software/jira

        

[jira] Commented: (DOXIA-397) Cannot link to javadoc methods

Posted by "Thom Nichols (JIRA)" <ji...@codehaus.org>.
    [ http://jira.codehaus.org/browse/DOXIA-397?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=226339#action_226339 ] 

Thom Nichols commented on DOXIA-397:
------------------------------------

So the behavior, if I understand correctly, relates to what's described here: http://maven.apache.org/doxia/references/doxia-apt.html#Links
Specifically, Doxia is parsing 'local' links as if they are 'anchors' (or 'internal links'?)  

If Doxia sees a link that starts with './' or '../', should it be manipulating it at all?  I thought a local link had to be a valid URI fragment?

> Cannot link to javadoc methods
> ------------------------------
>
>                 Key: DOXIA-397
>                 URL: http://jira.codehaus.org/browse/DOXIA-397
>             Project: Maven Doxia
>          Issue Type: Bug
>          Components: Core, Module - Apt, Module - Xdoc
>    Affects Versions: 1.1.3
>            Reporter: Lukas Theussl
>
> Using a link to a javadoc method like
> {noformat}
> {{{../apidocs/groovyx/net/http/ParserRegistry.html#parseText(org.apache.http.HttpResponse)}ParserRegistry}}
> {noformat}
> the apt parser removes the brackets of the anchor. The same thing happens with xdocs and probably other formats. Note that non-ascii characters are not legal in anchor names, but they should be replaced by their hex values, see http://www.w3.org/TR/html401/appendix/notes.html#non-ascii-chars.

-- 
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators: http://jira.codehaus.org/secure/Administrators.jspa
-
For more information on JIRA, see: http://www.atlassian.com/software/jira

        

[jira] Commented: (DOXIA-397) Cannot link to javadoc methods

Posted by "Thom Nichols (JIRA)" <ji...@codehaus.org>.
    [ http://jira.codehaus.org/browse/DOXIA-397?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=226562#action_226562 ] 

Thom Nichols commented on DOXIA-397:
------------------------------------

bq. It is assumed that site builders have control over both target ids and links for internal and local links, ie if Doxia fixes an invalid id, the developer should be forced to fix the link and avoid the warning.

But the _developer_ isn't being forced to fix the link, Doxia is attempting to fix it for me (and breaking it in the process.)  I think you mean, if Doxia fixes the link, the developer will be forced to fix the anchor that it points to?

bq. Unfortunately this is not possible for auto-generated docs that produce invalid anchors/links, like javadoc.

But even if I properly escape the link, Doxia still munges it.  I don't think this has anything to do with the fact that Javadoc leaves unescaped characters in the URI.  A valid URI like:
{noformat}
{{{../apidocs/groovyx/net/http/HTTPBuilder.html#defaultSuccessHandler%28org.apache.http.HttpResponse%2C%20java.lang.Object%29}defaultSuccessHandler}}
{noformat}
is still getting smashed by Doxia.  

I apologize for being dense, as I feel like keep asking the same question.  But the above link -- you said it cannot be a Doxia ID.  OK!  So if it's not a Doxia ID, then it must be a relative URI, right?  So if it's a relative URI, why would Doxia ever try to manipulate it?  And if it _does_ feel the need to manipulate a "non Doxia ID" link, shouldn't it just be doing normal URI escaping like replacing " " with "%20"?  But instead it appears that the "Doxia ID" rules (converting spaces to underscores and removing characters like '%') are being applied to links that are clearly relative URIs.  I guess I fail to understand what the intended goal is in this case.

Can't the logic be "If I see what appears to be a Doxia ID, perform the Doxia link/anchor manipulation."  "If I see a link that's _not_ a Doxia ID, just apply URI-escaping rules."

A link like "{{{Some Section Heading}blah}}" is clearly a Doxia ID, so don't change any of the current behavior in that case and preserve backward compatibility.

> Cannot link to javadoc methods
> ------------------------------
>
>                 Key: DOXIA-397
>                 URL: http://jira.codehaus.org/browse/DOXIA-397
>             Project: Maven Doxia
>          Issue Type: Bug
>          Components: Core, Module - Apt, Module - Xdoc
>    Affects Versions: 1.1.3
>            Reporter: Lukas Theussl
>
> Using a link to a javadoc method like
> {noformat}
> {{{../apidocs/groovyx/net/http/ParserRegistry.html#parseText(org.apache.http.HttpResponse)}ParserRegistry}}
> {noformat}
> the apt parser removes the brackets of the anchor. The same thing happens with xdocs and probably other formats. Note that non-ascii characters are not legal in anchor names, but they should be replaced by their hex values, see http://www.w3.org/TR/html401/appendix/notes.html#non-ascii-chars.

-- 
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators: http://jira.codehaus.org/secure/Administrators.jspa
-
For more information on JIRA, see: http://www.atlassian.com/software/jira

        

[jira] Commented: (DOXIA-397) Cannot link to javadoc methods

Posted by "Lukas Theussl (JIRA)" <ji...@codehaus.org>.
    [ http://jira.codehaus.org/browse/DOXIA-397?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=226342#action_226342 ] 

Lukas Theussl commented on DOXIA-397:
-------------------------------------

Not really, this issue has nothing to do with local, internal or external links. These notions only distinguish the case of where the link points to (target within same source document, target within same site, target outside), but in each case the URI has to be valid. Since Doxia 1.1 we fix all invalid ids, that's why the warning is emitted, you are supposed to correct the links in your source documents.

Btw, it should work if you use absolute links, as only local and internal links are re-written. Eg if you link from one apt document to another within your site, you can control both the link (href) and the target (anchor), but if you link to the internet, you usually do not control the target. Unfortunately, javadoc generates invalid anchors, which is apparently a well-known fact: http://mindprod.com/jgloss/javadoc.html

> Cannot link to javadoc methods
> ------------------------------
>
>                 Key: DOXIA-397
>                 URL: http://jira.codehaus.org/browse/DOXIA-397
>             Project: Maven Doxia
>          Issue Type: Bug
>          Components: Core, Module - Apt, Module - Xdoc
>    Affects Versions: 1.1.3
>            Reporter: Lukas Theussl
>
> Using a link to a javadoc method like
> {noformat}
> {{{../apidocs/groovyx/net/http/ParserRegistry.html#parseText(org.apache.http.HttpResponse)}ParserRegistry}}
> {noformat}
> the apt parser removes the brackets of the anchor. The same thing happens with xdocs and probably other formats. Note that non-ascii characters are not legal in anchor names, but they should be replaced by their hex values, see http://www.w3.org/TR/html401/appendix/notes.html#non-ascii-chars.

-- 
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators: http://jira.codehaus.org/secure/Administrators.jspa
-
For more information on JIRA, see: http://www.atlassian.com/software/jira

        

[jira] Updated: (DOXIA-397) Cannot link to javadoc methods

Posted by "Thom Nichols (JIRA)" <ji...@codehaus.org>.
     [ http://jira.codehaus.org/browse/DOXIA-397?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Thom Nichols updated DOXIA-397:
-------------------------------

    Attachment: apt-link-fix.diff

I've fixed this myself, the patch is trivial and I don't believe it breaks backwards compatibility.  Please try it out and let me know if it causes any problems with existing apt sources.

> Cannot link to javadoc methods
> ------------------------------
>
>                 Key: DOXIA-397
>                 URL: http://jira.codehaus.org/browse/DOXIA-397
>             Project: Maven Doxia
>          Issue Type: Bug
>          Components: Core, Module - Apt, Module - Xdoc
>    Affects Versions: 1.1.3
>            Reporter: Lukas Theussl
>         Attachments: apt-link-fix.diff
>
>
> Using a link to a javadoc method like
> {noformat}
> {{{../apidocs/groovyx/net/http/ParserRegistry.html#parseText(org.apache.http.HttpResponse)}ParserRegistry}}
> {noformat}
> the apt parser removes the brackets of the anchor. The same thing happens with xdocs and probably other formats. Note that non-ascii characters are not legal in anchor names, but they should be replaced by their hex values, see http://www.w3.org/TR/html401/appendix/notes.html#non-ascii-chars.

-- 
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators: http://jira.codehaus.org/secure/Administrators.jspa
-
For more information on JIRA, see: http://www.atlassian.com/software/jira

        

[jira] Commented: (DOXIA-397) Cannot link to javadoc methods

Posted by "Thom Nichols (JIRA)" <ji...@codehaus.org>.
    [ http://jira.codehaus.org/browse/DOXIA-397?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=226360#action_226360 ] 

Thom Nichols commented on DOXIA-397:
------------------------------------

Or, if it's not a valid Doxia ID, just complain (emit a warning message) but don't munge it.  

But maybe some people are relying on behavior to turn {{{Some Section Heading}blah}} into <a href='#Some_Section_Heading'>blah</a>

> Cannot link to javadoc methods
> ------------------------------
>
>                 Key: DOXIA-397
>                 URL: http://jira.codehaus.org/browse/DOXIA-397
>             Project: Maven Doxia
>          Issue Type: Bug
>          Components: Core, Module - Apt, Module - Xdoc
>    Affects Versions: 1.1.3
>            Reporter: Lukas Theussl
>
> Using a link to a javadoc method like
> {noformat}
> {{{../apidocs/groovyx/net/http/ParserRegistry.html#parseText(org.apache.http.HttpResponse)}ParserRegistry}}
> {noformat}
> the apt parser removes the brackets of the anchor. The same thing happens with xdocs and probably other formats. Note that non-ascii characters are not legal in anchor names, but they should be replaced by their hex values, see http://www.w3.org/TR/html401/appendix/notes.html#non-ascii-chars.

-- 
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators: http://jira.codehaus.org/secure/Administrators.jspa
-
For more information on JIRA, see: http://www.atlassian.com/software/jira

        

[jira] Commented: (DOXIA-397) Cannot link to javadoc methods

Posted by "Thom Nichols (JIRA)" <ji...@codehaus.org>.
    [ http://jira.codehaus.org/browse/DOXIA-397?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=226334#action_226334 ] 

Thom Nichols commented on DOXIA-397:
------------------------------------

It also removes commas (which are unescaped in JavaDoc links) and already-escaped octets lose the '%'.  So pre-escaping non-alphanumeric characters doesn't help in this case.

So 
{code}
{{{../apidocs/groovyx/net/http/HTTPBuilder.html#get%28java.util.Map,%20groovy.lang.Closure%29}get()}}>>> 
{code}
becomes
{code}
<a href='../apidocs/groovyx/net/http/HTTPBuilder.html#get28java.util.Map20groovy.lang.Closure29'>get()</a> 
{code}

> Cannot link to javadoc methods
> ------------------------------
>
>                 Key: DOXIA-397
>                 URL: http://jira.codehaus.org/browse/DOXIA-397
>             Project: Maven Doxia
>          Issue Type: Bug
>          Components: Core, Module - Apt, Module - Xdoc
>    Affects Versions: 1.1.3
>            Reporter: Lukas Theussl
>
> Using a link to a javadoc method like
> {noformat}
> {{{../apidocs/groovyx/net/http/ParserRegistry.html#parseText(org.apache.http.HttpResponse)}ParserRegistry}}
> {noformat}
> the apt parser removes the brackets of the anchor. The same thing happens with xdocs and probably other formats. Note that non-ascii characters are not legal in anchor names, but they should be replaced by their hex values, see http://www.w3.org/TR/html401/appendix/notes.html#non-ascii-chars.

-- 
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators: http://jira.codehaus.org/secure/Administrators.jspa
-
For more information on JIRA, see: http://www.atlassian.com/software/jira

        

[jira] Commented: (DOXIA-397) Cannot link to javadoc methods

Posted by "Michael Osipov (JIRA)" <ji...@codehaus.org>.
    [ http://jira.codehaus.org/browse/DOXIA-397?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=257279#action_257279 ] 

Michael Osipov commented on DOXIA-397:
--------------------------------------

Is there any update on this? Just ran into this annoying bug.

> Cannot link to javadoc methods
> ------------------------------
>
>                 Key: DOXIA-397
>                 URL: http://jira.codehaus.org/browse/DOXIA-397
>             Project: Maven Doxia
>          Issue Type: Bug
>          Components: Core, Module - Apt, Module - Xdoc
>    Affects Versions: 1.1.3
>            Reporter: Lukas Theussl
>         Attachments: apt-link-fix.diff
>
>
> Using a link to a javadoc method like
> {noformat}
> {{{../apidocs/groovyx/net/http/ParserRegistry.html#parseText(org.apache.http.HttpResponse)}ParserRegistry}}
> {noformat}
> the apt parser removes the brackets of the anchor. The same thing happens with xdocs and probably other formats. Note that non-ascii characters are not legal in anchor names, but they should be replaced by their hex values, see http://www.w3.org/TR/html401/appendix/notes.html#non-ascii-chars.

-- 
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators: http://jira.codehaus.org/secure/Administrators.jspa
-
For more information on JIRA, see: http://www.atlassian.com/software/jira

        

[jira] Commented: (DOXIA-397) Cannot link to javadoc methods

Posted by "Lukas Theussl (JIRA)" <ji...@codehaus.org>.
    [ http://jira.codehaus.org/browse/DOXIA-397?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=226338#action_226338 ] 

Lukas Theussl commented on DOXIA-397:
-------------------------------------

I was about to commit a fix when I saw your example above and realized that it won't work for more than one argument. The problem is the space after the comma, which doxia replaces by an underscore, instead of its hex value (http://maven.apache.org/doxia/doxia/doxia-core/apidocs/org/apache/maven/doxia/util/DoxiaUtils.html#encodeId%28java.lang.String,%20boolean%29 ).

The reason for this choice of replacement, I think, was to generate readable links for the most typical use-case of anchors in apt documents, eg links to section titles, etc. I'm afraid we will break a lot of stuff if we change this now.


> Cannot link to javadoc methods
> ------------------------------
>
>                 Key: DOXIA-397
>                 URL: http://jira.codehaus.org/browse/DOXIA-397
>             Project: Maven Doxia
>          Issue Type: Bug
>          Components: Core, Module - Apt, Module - Xdoc
>    Affects Versions: 1.1.3
>            Reporter: Lukas Theussl
>
> Using a link to a javadoc method like
> {noformat}
> {{{../apidocs/groovyx/net/http/ParserRegistry.html#parseText(org.apache.http.HttpResponse)}ParserRegistry}}
> {noformat}
> the apt parser removes the brackets of the anchor. The same thing happens with xdocs and probably other formats. Note that non-ascii characters are not legal in anchor names, but they should be replaced by their hex values, see http://www.w3.org/TR/html401/appendix/notes.html#non-ascii-chars.

-- 
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators: http://jira.codehaus.org/secure/Administrators.jspa
-
For more information on JIRA, see: http://www.atlassian.com/software/jira

        

[jira] Commented: (DOXIA-397) Cannot link to javadoc methods

Posted by "Lukas Theussl (JIRA)" <ji...@codehaus.org>.
    [ http://jira.codehaus.org/browse/DOXIA-397?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=226532#action_226532 ] 

Lukas Theussl commented on DOXIA-397:
-------------------------------------

A link like

{noformat}
{{{../apidocs/groovyx/.....}}}
{noformat}

is not a Doxia id because it contains slashes.

bq. just complain (emit a warning message) but don't munge it.

It is assumed that site builders have control over both target ids and links for internal and local links, ie if Doxia fixes an invalid id, the developer should be forced to fix the link and avoid the warning. Unfortunately this is not possible for auto-generated docs that produce invalid anchors/links, like javadoc.

bq. But maybe some people are relying on behavior to turn {{{Some Section Heading}blah}} into <a href='#Some_Section_Heading'>blah</a>

Yes, that's the origin of the problem, we would break  a lot of existing links if we changed that now.

> Cannot link to javadoc methods
> ------------------------------
>
>                 Key: DOXIA-397
>                 URL: http://jira.codehaus.org/browse/DOXIA-397
>             Project: Maven Doxia
>          Issue Type: Bug
>          Components: Core, Module - Apt, Module - Xdoc
>    Affects Versions: 1.1.3
>            Reporter: Lukas Theussl
>
> Using a link to a javadoc method like
> {noformat}
> {{{../apidocs/groovyx/net/http/ParserRegistry.html#parseText(org.apache.http.HttpResponse)}ParserRegistry}}
> {noformat}
> the apt parser removes the brackets of the anchor. The same thing happens with xdocs and probably other formats. Note that non-ascii characters are not legal in anchor names, but they should be replaced by their hex values, see http://www.w3.org/TR/html401/appendix/notes.html#non-ascii-chars.

-- 
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators: http://jira.codehaus.org/secure/Administrators.jspa
-
For more information on JIRA, see: http://www.atlassian.com/software/jira