diff options
Diffstat (limited to 'doc/features.doc')
| -rw-r--r-- | doc/features.doc | 23 |
1 files changed, 14 insertions, 9 deletions
diff --git a/doc/features.doc b/doc/features.doc index aa3a33a..4381bc7 100644 --- a/doc/features.doc +++ b/doc/features.doc @@ -22,6 +22,15 @@ <li>Requires very little overhead from the writer of the documentation. Plain text will do, but for more fancy or structured output HTML tags and/or some of doxygen's special commands can be used. +<li>Supports C++, (Corba or Microsoft) IDL and C sources. +<li>Supports documentation of files, namespaces, classes, structs, unions, + templates, variables, functions, typedefs, enums and defines. +<li>JavaDoc (1.1), Qt-Doc, and KDOC compatible. +<li>Automatically generates class diagrams in HTML (as clickable + image maps) and \f$\mbox{\LaTeX}\f$ (as encapsulated postscript images). +<li>Allows you to put documentation in the header file (before the + declaration of an entity), source file (before the definition of an entity) + or in a separate file. <li>Outputs documentation in on-line format (HTML and UNIX man page) and off-line format (\f$\mbox{\LaTeX}\f$) simultaniously (any one can be disabled if desired). Both formats are optimized for @@ -29,23 +38,18 @@ Furthermore, compressed HTML can be generated from HTML output using Microsoft's HTML help workshop (Windows only) and PDF can be generated from the \f$\mbox{\LaTeX}\f$ output. -<li>Allows documentation of files, namespaces, classes, structs, unions, - templates, variables, functions, typedefs, enums and defines. <li>Includes a full C preprocessor to allow proper parsing of conditional - code fragments and to allow expansion of all or part of the define macros. + code fragments and to allow expansion of all or part of macros definitions. <li>Automatically detects public, protected and private sections, as well as the Qt specific signal and slots sections. Extraction of private class members is optional. -<li>Automatically generates of class diagrams in HTML (as clickable - image maps) and \f$\mbox{\LaTeX}\f$ (as encapsulated postscript images). -<li>JavaDoc (1.1) and Qt-Doc compatible. +<li>Automatically generates references to documented classes, files, namespaces + and members. Documentation of global functions, globals variables, + typedefs, defines and enumerations is also supported. <li>References to base/super classes and inherited/overridden members are generated automatically. <li>Includes a fast, rank based search engine to search for strings or words in the class and member documentation. -<li>Automatic generation of references to documented classes, files and - members. Documentation of global functions, globals variables, - typedefs, defines and enumerations is also supported. <li>Documentation may be placed either at the declaration or at the definition of a member function or class. Most documentation systems (such as Javadoc) only support the former, others (such as Qt) only the latter. @@ -61,6 +65,7 @@ looking into the implementation details. <li>Allows automatic cross-referencing of (documented) entities with their definition in the source code. +<li>Allows inclusion of function/member/class definitions in the documentation. <li>All options are read from an easy to edit and documented configuration file. <li>Documentation and search engine can be transferred to another |