summaryrefslogtreecommitdiffstats
path: root/doc/features.doc
diff options
context:
space:
mode:
Diffstat (limited to 'doc/features.doc')
-rw-r--r--doc/features.doc23
1 files changed, 14 insertions, 9 deletions
diff --git a/doc/features.doc b/doc/features.doc
index 7159124..aa3a33a 100644
--- a/doc/features.doc
+++ b/doc/features.doc
@@ -22,9 +22,13 @@
<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>Outputs documentation in on-line format (HTML and man page) and off-line
- format (LaTeX) simulatiously (any one can be disabled if desired).
- Both formats are optimized for ease of reading.
+<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
+ ease of reading. <br>
+ 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
@@ -33,7 +37,7 @@
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 Latex (as encapsulated postscript).
+ image maps) and \f$\mbox{\LaTeX}\f$ (as encapsulated postscript images).
<li>JavaDoc (1.1) and Qt-Doc compatible.
<li>References to base/super classes and inherited/overridden members are
generated automatically.
@@ -46,7 +50,8 @@
of a member function or class. Most documentation systems (such as Javadoc) only
support the former, others (such as Qt) only the latter.
<li>You can type normal HTML tags in your documentation. Doxygen will convert
- them to their equivalent Latex and man-page counterparts automatically.
+ them to their equivalent \f$\mbox{\LaTeX}\f$ and man-page
+ counterparts automatically.
<li>Allows references to documentation generated for other projects
(or another part of the same project) in a location independent way.
<li>Allows inclusion of source code examples that are automatically
@@ -54,12 +59,12 @@
<li>Inclusion of undocumented classes is also supported, allowing to quickly
learn the structure and interfaces of a (large) piece of code without
looking into the implementation details.
-<li>All options are read from an easy to edit and documented configuration
- file.
+<li>Allows automatic cross-referencing of (documented) entities with their
+ definition in the source code.
+<li>All options are read from an easy to edit and documented
+ configuration file.
<li>Documentation and search engine can be transferred to another
location or machine without regenerating the documentation.
-<li>Doxygen can generate index and project files that can
- be converted into compressed HTML by MicroSoft's HTML help workshop.
<li>Can cope with large projects easily.
</UL>