Maven Doxia

Fix broken fragment links in Doxia

Details

  • Type: Bug Bug
  • Status: Closed Closed
  • Priority: Major Major
  • Resolution: Duplicate
  • Affects Version/s: 1.2
  • Fix Version/s: None
  • Component/s: Module - Apt
  • Labels:
    None
  • Number of attachments :
    0

Description

Using APT in maven-site-plugin:3.0-beta-3, it is impossible to link to a class member in Javadoc, because the link requires a fragment to be used which is shredded by the APT conversion. You can't even link to Object.toString() because this would be converted to href="Object.html#toString()". While this makes a perfectly valid fragment according to RFC 2396, APT shreds it to some unusable result.

Please fix this linking feature - it's utterly broken! APT should not touch fragments at all when referring to external links.

Issue Links

duplicates

Bug - A problem which impairs or prevents the functions of the product. DOXIA-397 Cannot link to javadoc methods

  • Major - Major loss of function.
  • Closed - The issue is considered finished, the resolution is correct. Issues which are not closed can be reopened.
relates to

Bug - A problem which impairs or prevents the functions of the product. DOXIA-429 Broken link syntax in APT

  • Minor - Minor loss of function, or other problem where easy workaround is present.
  • Closed - The issue is considered finished, the resolution is correct. Issues which are not closed can be reopened.

Activity

Ascending order - Click to sort in descending order
Hide
Permalink
Lukas Theussl added a comment -

Is this the same as DOXIA-397? What is exactly your apt input and the expected vs. actual output?

Show
Lukas Theussl added a comment - Is this the same as DOXIA-397 ? What is exactly your apt input and the expected vs. actual output?
Hide
Permalink
Christian Schlichtherle added a comment - - edited

For example, in an APT file, I have this sentence:

For example, by using the multi-threaded method
{{{./apidocs/de/schlichtherle/truezip/file/TFile.html#cat(java.io.InputStream, java.io.OutputStream)}<<<TFile.cat(InputStream, OutputStream)>>>}},
you'll never have to write a naive read-then-write loop again.

It doesn't work because the fragment gets shredded.

Show
Christian Schlichtherle added a comment - - edited For example, in an APT file, I have this sentence: For example, by using the multi-threaded method {{{./apidocs/de/schlichtherle/truezip/file/TFile.html#cat(java.io.InputStream, java.io.OutputStream)}<<<TFile.cat(InputStream, OutputStream)>>>}}, you'll never have to write a naive read-then-write loop again. It doesn't work because the fragment gets shredded.
Hide
Permalink
Lukas Theussl added a comment -

This is the same as DOXIA-397.

Show
Lukas Theussl added a comment - This is the same as DOXIA-397 .

People

  • Assignee:
    Lukas Theussl
    Reporter:
    Christian Schlichtherle
Vote (0)
Watch (0)

Dates

  • Created:
    Updated:
    Resolved: