maven-issues mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Lukas Theussl (JIRA)" <j...@codehaus.org>
Subject [jira] Commented: (DOXIA-397) Cannot link to javadoc methods
Date Fri, 25 Jun 2010 13:45:12 GMT

    [ 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

        

Mime
View raw message