J
John Ersatznom
It seems to be possible to a) include package-summary javadocs using
Eclipse (in package view, right click, "new file", "package.html"; it
will open a blank page in your browser, so you have to return to eclipse
and drag the "package.html" entry to the document editing area then
enter your html) and b) link to your package summary from other javadocs
(IDE-independent; {@link foo.bar.package.name sometext}). Unfortunately,
javadoc seems to strip the anchor (e.g. @link foo.bar#baz sometext
results in <a href="blahblah/foo/bar/package-summary.html">sometext</a>,
note no #baz on URL) and the package summary text is usually well below
the fold when the link is followed. Being able to link to a particular
part of your summary text would be useful. Any suggestions, short of
putting the <a href> link directly into the javadocs and watching it
break every time your directory structure changes?
Eclipse (in package view, right click, "new file", "package.html"; it
will open a blank page in your browser, so you have to return to eclipse
and drag the "package.html" entry to the document editing area then
enter your html) and b) link to your package summary from other javadocs
(IDE-independent; {@link foo.bar.package.name sometext}). Unfortunately,
javadoc seems to strip the anchor (e.g. @link foo.bar#baz sometext
results in <a href="blahblah/foo/bar/package-summary.html">sometext</a>,
note no #baz on URL) and the package summary text is usually well below
the fold when the link is followed. Being able to link to a particular
part of your summary text would be useful. Any suggestions, short of
putting the <a href> link directly into the javadocs and watching it
break every time your directory structure changes?