Expert Spring MVC and Web Flow

Listing A-3.Graphviz Executable Location

# for Unix/Linux i.e.

compiler.dotExe=/usr/bin/dot

# OR for Windows..

compiler.dotExe=C:/Program Files/ATT/GraphViz/bin/dot.exe

The next important option is choosing JavaDoc locations. BeanDoc will by default link

any classname attributes of your beans to their JavaDoc page for several well-known libraries.

These include the standard Java API for your platform, Spring classes, and many others. You

can override the locations for these (for example, if you have them installed locally) and add

your own by setting one or more properties similar to those shown in Listing A-4.

Listing A-4.Specifying JavaDoc Locations

javadoc.locations[com.mycompany]=http://your.local.server/apidoc/

javadoc.locations[com.vendor]=http://www.vendor.com/javadoc/

The format of each line is the same: In brackets after the javadoc.locationspart you

place the prefix of the classnames that should link to the URL used as the property value.

In the listing above, a classname of com.mycompany.foo.Barwill be linked to

http://your.local.server.com/apidoc/com/mycompany/foo/Bar.html.

Summary

We’ve taken a brief look at BeanDoc and some of the basic options that you can take to cus-

tomize the way it works. In fact, the tool has many more options for controlling graph layouts

and colors that can be selected in beandoc.properties. It is quite extensible too, and you can

switch out the XSLT stylesheets or add new components to it if you require something a bit

out of the ordinary. BeanDoc’s reference documentation contains all the information you

need to delve beyond the basics.

APPENDIX A ■DOCUMENTING YOUR MVC APPLICATION 375

584X_Ch13_AppA_FINAL 1/30/06 1:13 PM Page 375