Home.... | log in.... | Pub my question! | Sign-up....
Java-index >> Developer Tools >> Debugging and Profiling Tool APIs

Links to common documents / HTML Pages

Is there a way to create links in Javadoc to a common document. For example, I have a glossary doc that I would like to link to in various places. Using doc-files would be fine if all of my javadoc came out of one package. But there are many packages and I don't want to copy the glossary doc file to multiple doc-files directories.

xxx.xxx.xxx.xxx.xxx.pg1.ClassA

xxx.xxx.xxx.xxx.xxx.pg2.ClassB

xxx.xxx.xxx.xxx.xxx.pg3.ClassC

xxx.xxx.xxx.xxx.xxx.pg4.ClassD

xxx.xxx.xxx.xxx.xxx.pg5.ClassE

/myGlossary/Dir/myGlossary.doc

Each class has five methods and I want to add a link in each method to document myGlossary.doc

Actually myGlossary.doc could be anything... HTML, PDF, XLS,

Thanks in advance.

[756 byte] By [mpbaker01a] at [2007-10-2 16:24:42]
«« creating a preview window
»» JSP
# 1

Javadoc has the {@docroot} inline tag, which resolves to the

relative path that takes you to the root of the doc tree:

http://java.sun.com/j2se/1.5.0/docs/tooldocs/windows/javadoc.html#{@docRoot}

You can use that in conjunction with a "doc-files" directory at the root

of the source tree. This directory should be copied to the root of the

doc tree (looks like the Javadoc reference documentation was never updated to mention this):

"Fixed doc-files directory at doc root to be copied to destination.

This enables the inclusion of overview-level documentation to be included. (4256505)"

http://java.sun.com/j2se/1.5.0/docs/guide/javadoc/whatsnew-1.4.html

Let us know if this works.

-Doug

dhkramera at 2007-7-13 17:23:01 > top of Java-index,Developer Tools,Debugging and Profiling Tool APIs...
Developer Tools
Debugging and Profiling Tool APIs

Developer Tools New Topic

Developer Tools Hot Topic

Developer Tools

All Classified