Eiffeldoc
Jump to navigation
Jump to search
The printable version is no longer supported and may have rendering errors. Please update your browser bookmarks and please use the default browser print function instead.
*** TO BE UPDATED from the French version, command line options and html classes have changed *** and usage notes have been added. *** Thanks!
eiffeldoc
is, starting from the 2.2 release, the tools that documents a whole project.
Currently only HTML output is supported, but maybe others will be added in the future.
Synopsis
eiffeldoc {-title title} {-home_address address} {-nav_css file} {-doc_css file} {-class_css file} {-arrow_address address} {-separator_address address} {-depends} {-prune cluster...} {-verbose} {-help} [loadpath.se | ACE file]
-title
|
The title of the generated documentation |
-home_address
|
The address of the go home upper-left link. If -home_address is not given, the go home upper link won't be generated.
|
-home_image_address
|
The address of the go home image |
-nav_css
|
The stylesheet to use in the navigation bar (i.e. the left frames) |
-doc_css
|
The stylesheet to use in the cluster documentation (i.e. on the right frames) |
-class_css
|
The stylesheet to use in the class documentation (i.e. on the right frames) |
-arrow_address
|
The address of the arrow image. If the -arrow_address is not given, links in the left navigation bar won't have an arrow.
|
-separator_address
|
The address of the separator image. If the -separator_address is not given, there will be no separation before the description of a cluster.
|
-prune
|
Don't show the cluster nor its classes in the left navigation bar. It uses the loadpath.se or ACE syntax for paths. Note that it also removes all the subclusters.
Example: |
-depends
|
Generate dependant classes even if their cluster is pruned. This helps avoiding dangling links. |
-verbose
|
Output a lot of information about what eiffeldoc is doing. |
Stylesheets
The stylesheets are heavily used to customize the output of Eiffeldoc. The known classes are:
A.home | for the home link |
A.title | for the titles |
A.cluster | for the clusters |
A.class | for the classes |
A.client | for the upper-right clients frame |
A.description | for the one-sentence description in the cluster summary |
TD.home | for the home link |
TD.title | for the titles |
TD.cluster | for the clusters |
TD.class | for the classes (except in the short proper) |
TD.client | for the upper-right clients frame |
TD.description | for the one-sentence description in the cluster summary |
B.obsolete | for the obsolete header |
I.obsolete | for the obsolete message |
TD.comment | for the comment of a class |
PRE.comment | for the comment of a class |
B.comment | for the comment of a feature clause |
I.comment | for the comment of a feature |
LI.summary | for a feature in the summary |
A.summary | for the feature link in the summary |
TD.details | for a feature definition in the details section |
B.details | for the feature name in the details section |
B.assertion | for the assertion tags |
TT.assertion | for the assertion expressions |
I.assertion | for the assertion comments |
A.link | for a class link in the class documentation |
U.field | for a field link in a comment, not linked |
A.field | for a field link in a comment, linked |
TT.character | for a character in a comment |
TT.string | for a string in a comment |