Applies to Java only
To add documentation links, you must specify the location of a (set of) properties file(s) that contains a list of all identifiers you want hyperlinked, and the URL to link to. A snippet of such a properties file might look as:
java.io.File = http://java.sun.com/j2se/1.5.0/docs/api/java/io/File.html
The default distribution comes with two such files :
To specify the location of these files, use the javadoc property:
| HTMLConverter | configure("javadoc","list,of,files") | |
| Code2Web | code2web ... --javadoc = xxxxx ... | |
| <c2w:convert> | <c2w:convert ... javadoc="style" ... > |
Since code2web is not a compiler and does not build a syntax tree, it has no way of determining whether an identifier corresponds to a class or to some other thing, so it uses more or less the strategy "if I find the identifier in the list of classes that I know, then it must be a class". (But see "known problems" for situations in which this is not correct).
The style of the documentation links is controlled by the docLinkStyle property. The default value is "doc-link"
| HTMLConverter | String getDocLinkStyleStyle() void setDocLinkStyle( String style ) |
|
| Code2Web | code2web ... --docLinkStyle = xxxxx ... | |
| <c2w:convert> | <c2w:convert ... docLinkStyle="style" ... > |