   The eiffeldoc Command

   The  eiffeldoc  command  is  the  SmartEiffel documentation system. It
   produces high quality HTML files that form the API of a system.
   The  generated documentation is split in a lot of HTML files. You need
   know only one of them: the entry point of the API is named index.html.

   Usage

   se doc [options] [<loadpath.se>|<ACE file>]

   Options

   -prune <cluster>:
          Allows  to  remove  a  cluster  and  all  its sub-clusters. For
          example,  not  to  include  the lib/io classes in the generated
          API, use -prune lib/io
   -help:
          Display a brief summary of the command-line syntax.
   -verbose:
          Displays  (a  lot  of)  useful information during the generated
          (full path of loaded files, generated files, etc.).
   -title <title>:
          Sets the title of the generated documentation
   -home_address <address>:
          Sets the address of a "home page" to return to. If this address
          is not specified, no "home page" link will be generated.
   -home_image_address <address>:
          Sets  the  address  of  the  image to use instead of the "home"
          link.  Click  on  this image will return to the specified "home
          page". Not used if -home_address is not set.
   -arrow_address <address>:
          Sets  the  address  of  the  image to use where an arrow can be
          drawn. An arrow may be used at the following locations:
          + in the navigation bar: the list of clusters
          + in the navigation bar: the list of classes
          + in   the   clusters   documentation:  link  to  the  detailed
            documentation
   -separator_address <address>:
          Sets  the  address  of  the  image to use as separator (usually
          something like an horizontal rule).
   -nav_css <CSS file>:
          Sets  the  name  of  the CSS file to use for the navigation bar
          (i.e.  the  left  frames).  The file is copied in the generated
          documentation.
   -doc_css <CSS file>:
          Sets  the  name  of  the  CSS  file  to  use  for  the clusters
          documentation  (i.e.  the  right frames). The file is copied in
          the generated documentation.
   -class_css <CSS file>:
          Sets  the name of the CSS file to use for the classes API (i.e.
          the  right  frames).  The  file  is  copied  in  the  generated
          documentation.
   -depends:
          The  classes  that  are in pruned clusters will be generated if
          they  are  used  by  a  class.  This  allows an API to be quite
          complete, without dangling links.

   CSS files

   CSS  files  are  used to describe the style of the API. Many parts, if
   not all, of the API may be customized.

   the nav_css:
          This  file  controls  the  display  of  the navigation bar. The
          following classes are supported:

                            A.home                          the home link
                           A.title                             the titles
                         A.cluster                     the clusters links
                           A.class                      the classes links
                           TD.home      the cell containing the home link
                          TD.title          the cell containing the title
                        TD.cluster the cell containing the clusters links
                          TD.class  the cell containing the classes links
   the doc_css:
          This  file  controls the display of the clusters documentation.
          The following classes are supported:

                   A.title                                     the titles
                 A.cluster                             the clusters links
                   A.class                              the classes links
             A.description                     the "see description" link
                  TD.title                  the cell containing the title
                TD.cluster         the cell containing the clusters links
                  TD.class          the cell containing the classes links
            TD.description the cell containing the "see description" link
   the class_css:
          This  file  controls  the display of the classes documentation.
          The following classes are supported:

      H1.title                                            the name of the class
      H3.title          the name of the client of the class; also the "Creation
                                       features" and "Exported features" titles
        A.link                            a link to another class documentation
    TD.comment                     the cell containing the class header comment
   PRE.comment                                         the class header comment
      H2.title                               the "Summary" and "Details" titles
     B.comment                                  the comment of a feature clause
    LI.summary                  a feature of the class in the "summary" section
     A.summary                             the link to the details of a feature
     I.comment                                         the comment of a feature
       U.field          a field (feature or anything between a back-quote and a
               forward quote), when this field is not a link (does not point to
                                                                anything known)
       A.field          a field (feature or anything between a back-quote and a
                                      forward quote), when this field is a link
      TD.title         the cell containing the name of a feature in the details
                                                                        section
     B.details                     the name of a feature in the details section
    TD.details                     the cell containing the details of a feature
   B.assertion          the "Require" and "Ensure" titles; also the tags of the
                                                                     assertions
  TT.assertion                                   the expression of an assertion
   I.assertion                                      the comment of an assertion
  TT.character               a character (delimited between simple quotes) in a
                                                                        comment
     TT.string          a string (delimited between double quotes) in a comment

                                   [Line]
             Copyright  Dominique COLNET and Suzanne COLLIN -
                         [1]<SmartEiffel@loria.fr>
                Last modified: Sat May 7 23:15:16 CEST 2005

References

   1. mailto:SmartEiffel@loria.fr
