JDK-4172027 : Linking from javadoc to source code
  • Type: Enhancement
  • Component: tools
  • Sub-Component: javadoc(tool)
  • Affected Version: 1.2.0
  • Priority: P4
  • Status: Closed
  • Resolution: Duplicate
  • OS: windows_nt
  • CPU: x86
  • Submitted: 1998-09-08
  • Updated: 2014-05-05
  • Resolved: 1998-09-10
Related Reports
Duplicate :  
Description

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)
======================================================================