Maven JXR
  1. Maven JXR
  2. JXR-10

Create a named anchor for each symbol like Javadoc does

    Details

    • Type: Improvement Improvement
    • Status: Closed Closed
    • Priority: Minor Minor
    • Resolution: Won't Fix
    • Affects Version/s: None
    • Fix Version/s: None
    • Component/s: jxr
    • Labels:
      None
    • Number of attachments :
      0

      Description

      I want to reference source code from XDoc. By now I'm writing a link like this:
      <a href="./../xref/com/acme/foo/Foo.html#127">method here</a>

      The problem is, my link can lead to a wrong place just after a few cosmetic changes in source code. Of course, automatic link check will not guess the link went wrong.

      It would be nice to generate named anchors in XRef the same way Javadoc does, supporting a link like this from XDoc:
      <a href="./../xref/com/acme/foo/Foo.html#bar(Object)">method here</a>

      Another way to achieve the same result would be to parse Java comments to find a special expression to be transformed in a named anchor, but the Javadoc way seems more straightforward.

        Issue Links

          Activity

          Hide
          Brett Porter added a comment -

          sounds like a JXR bug... should be filed there. We can upgrade to a new version once it is fixed there.

          Show
          Brett Porter added a comment - sounds like a JXR bug... should be filed there. We can upgrade to a new version once it is fixed there.
          Hide
          Brett Porter added a comment -

          I think I'm deluded, this is actually the right place to file this bug

          Show
          Brett Porter added a comment - I think I'm deluded, this is actually the right place to file this bug
          Hide
          Vincent Siveton added a comment -
          Show
          Vincent Siveton added a comment - Could be done with Forrestdoc http://svn.apache.org/repos/asf/forrest/trunk/whiteboard/forrestdoc/
          Show
          Vincent Siveton added a comment - http://www.nabble.com/Discuss-about-JXR-issues-tf3861012s177.html
          Hide
          Matthew Beermann added a comment -

          This issue hasn't had any updates in a long time; any progress? We have a regulatory requirement to link each of our functional requirements to one or more test cases, and as the reporter said, line numbers tend to be very brittle...

          Show
          Matthew Beermann added a comment - This issue hasn't had any updates in a long time; any progress? We have a regulatory requirement to link each of our functional requirements to one or more test cases, and as the reporter said, line numbers tend to be very brittle...
          Hide
          Michael Osipov added a comment -

          Is there anyone who would like to work on it?

          Show
          Michael Osipov added a comment - Is there anyone who would like to work on it?
          Hide
          Michael Osipov added a comment - - edited

          This cannot be solved with JXR unless completely rewritten. JXR is completely line-based. It would require JXR to create an AST from the source file to be aware of the current node. This would be a reimplementation of Javadoc in some way.

          Show
          Michael Osipov added a comment - - edited This cannot be solved with JXR unless completely rewritten. JXR is completely line-based. It would require JXR to create an AST from the source file to be aware of the current node. This would be a reimplementation of Javadoc in some way.

            People

            • Assignee:
              Unassigned
              Reporter:
              Laurent Caillette
            • Votes:
              1 Vote for this issue
              Watchers:
              3 Start watching this issue

              Dates

              • Created:
                Updated:
                Resolved: