Uploaded image for project: 'JDK'
  1. JDK
  2. JDK-4172027

Linking from javadoc to source code

XMLWordPrintable

    • Icon: Enhancement Enhancement
    • Resolution: Duplicate
    • Icon: P4 P4
    • None
    • 1.2.0
    • tools



      Name: clC74495 Date: 09/08/98


      (This seems pretty obvious, so my apologies if it
      has been suggested before, but it is not yet part of
      javadoc, so here goes...)

      The usual next step to learn more about a method
      after reading the detailed documentation is to look
      at the actual source code. It seems to me that it would
      be quite easy for javadoc to provide a little icon in
      in the entry for each method which jumps to the
      corresponding source code from which the document was
      produced.

      The only difficulty with implementing this is that
      there won't usually be a named anchor for each method
      in the source. On the one hand, just loading the correct
      source file into the browser would be a great time-saver.
      It also should be easy to also provide a simple
      java applet which finds the line on which the corresponding
      method actually starts.
      (Review ID: 38471)
      ======================================================================

            rfield Robert Field (Inactive)
            clucasius Carlos Lucasius (Inactive)
            Votes:
            0 Vote for this issue
            Watchers:
            0 Start watching this issue

              Created:
              Updated:
              Resolved:
              Imported:
              Indexed: