Difference between revisions of "Eiffeldoc"

From Liberty Eiffel Wiki
Jump to: navigation, search
(Synopsis)
(Stylesheets)
Line 103: Line 103:
 
|-
 
|-
 
| TD.comment
 
| TD.comment
| for the comment of a class
+
| for a class comment
 
|-
 
|-
 
| PRE.comment
 
| PRE.comment
| for the comment of a class
+
| for a class comment
 
|-
 
|-
 
| B.comment
 
| B.comment
| for the comment of a feature clause
+
| for a feature clause comment
 
|-
 
|-
 
| I.comment
 
| I.comment
| for the comment of a feature
+
| for a feature comment
 
|-
 
|-
 
| LI.summary
 
| LI.summary
Line 138: Line 138:
 
| for a class link in the class documentation
 
| for a class link in the class documentation
 
|-
 
|-
| U.field
+
| U.wiki_entity
| for a field link in a comment, not linked
+
| for a link to a field in a comment, not anchored ''?Is 'anchor' the correct translation of 'lier' here?''
 
|-
 
|-
| A.field
+
| A.wiki_entity
| for a field link in a comment, linked
+
| for a link to a field in a comment, anchored
 
|-
 
|-
| TT.character
+
| B.wiki_bold
| for a character in a comment
+
| for bold elements in a comment (wiki syntax)
 
|-
 
|-
  +
| I.wiki_italics
| TT.string
 
| for a string in a comment
+
| for italic elements in a comment (wiki syntax)
  +
|-
  +
| TT.wiki_class_name
  +
| for class names in a comment
  +
|-
  +
| TT.wiki_string
  +
| for character strings in a comment
  +
|-
  +
| TT.wiki_character
  +
| for characters in a comment
  +
|-
  +
| UL.wiki_bullet_list
  +
| for bullet-point lists
  +
|-
  +
| LI.wiki_bullet_list
  +
| for bullet-point list items
  +
|-
  +
| OL.wiki_numbered_list
  +
| for numbered lists
  +
|-
  +
| LI.wiki_numbered_list
  +
| for numbered list items
  +
|-
  +
| A.wiki_url
  +
| for URLs (between <nowiki>[...]</nowiki>)
  +
|-
  +
| A.wiki_word
  +
| for wiki words (between <nowiki>[[...]]</nowiki>)
 
|}
 
|}

Revision as of 14:26, 4 August 2005


*** 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} {-wiki_prefix prefix} [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: se doc -prune 'lib/scoop'

-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.
-wiki_prefix Generate links to wiki URLs (in square brackets)

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 a class comment
PRE.comment for a class comment
B.comment for a feature clause comment
I.comment for a feature comment
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.wiki_entity for a link to a field in a comment, not anchored ?Is 'anchor' the correct translation of 'lier' here?
A.wiki_entity for a link to a field in a comment, anchored
B.wiki_bold for bold elements in a comment (wiki syntax)
I.wiki_italics for italic elements in a comment (wiki syntax)
TT.wiki_class_name for class names in a comment
TT.wiki_string for character strings in a comment
TT.wiki_character for characters in a comment
UL.wiki_bullet_list for bullet-point lists
LI.wiki_bullet_list for bullet-point list items
OL.wiki_numbered_list for numbered lists
LI.wiki_numbered_list for numbered list items
A.wiki_url for URLs (between [...])
A.wiki_word for wiki words (between [[...]])