Xref-Tech


Xref-java2html
Java Cross Referencing and Documentation Tool
Current version: 1.4.0




THIS PRODUCT IS NO LONGER MAINTAINED BY XREF-TECH! YOU ARE INVITED TO USE Xrefactory WHEN NEEDING A CROSS REFERENCING C/C++/JAVA TO HTML CONVERTOR!




About

Xref-Java2Html is a Java documentation tool able to enhance standard javadoc documentation by fully cross-referencing source code. The documentation can then answer questions such as: Where is this field defined? Where is it used? Is it used somewhere in subclasses? Is it overriden in some subclasses? Which virtual methods can be invoked at this place? Where can this method be invoked? Where is this class defined? Where is this package used? Many other similar questions about symbol definition and usage can also be answered.

In the source code each symbol is linked to its definition and the definition to all usages. The first character of the symbol is made a short cut to the cross-references. A relevant class subtree is generated for each symbol. Symbols coming from the standard Java library are linked to their JavaDoc documentation.

Xref-Java2Html is designed for small and medium sized projects (up to 200 000 lines of source code).

Example

Here is an example of documentation generated with Xref-Java2Html (+ JavaDoc).

License

Xref-Java2Html is free for non-commercial use on Linux/Intel and Windows platforms. For use in a commercial project (or on another platform) you will need to purchase it as part of Xrefactory.

WARRANTY

THIS SOFTWARE IS PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT.

Download

Version 1.4 of Xref-Java2Html has a graphical user interface and is packed into auto-installing jars:

Port Name Size Http
xref-java2html-i86pc-linux 350 kB Download
xref-java2html-i86pc-windows 300 kB Download

After downloading type: 
java -jar xref-java2html-i86pc-windows.jar
or
java -jar xref-java2html-i86pc-linux.jar
and then in the created directory type 
 java -jar java2html.jar
to run the GUI.

How to add sources to JavaDoc documentation.

1.) Run javadoc on your sources with the -linksource option. Option -private is recommended if you wish to have all methods documented. For example: (here -d option sets the target directory) 

javadoc -linksource -private -d /J2HTML sk.xref.jarSelfExtractor sk.xref.java2html

2.) Run xref-java2html: 

java -jar java2html.jar

3.) Using the GUI set the 'Target Directory' to the src-html directory generated by the javadoc. For example, '/J2HTML/src-html'

4.) Set 'Sources' to your source directory. For example '/home/vittek/java-sources/sk/xref'.

5.) Set 'Cut paths' to your sourcepath, i.e. the source directories containing top level packages. For example, '/home/vittek/java-sources'.

6.) Run java2html by pressing the 'Run' button.

Feedback

You are invited to post your observations and bug reports to our discussion forum