summaryrefslogtreecommitdiffstats
path: root/doc/features.doc
diff options
context:
space:
mode:
Diffstat (limited to 'doc/features.doc')
-rw-r--r--doc/features.doc12
1 files changed, 6 insertions, 6 deletions
diff --git a/doc/features.doc b/doc/features.doc
index cec1dae..3298b0b 100644
--- a/doc/features.doc
+++ b/doc/features.doc
@@ -29,15 +29,17 @@
<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>Using the dot tool of the Graphviz tool kit doxygen can generate
+<li>Uses the dot tool of the Graphviz tool kit to generate
include dependency graphs, collaboration diagrams, and
graphical class hierarchy graphs.
<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>Can generate a list of all members of a class (including any inherited
+ members) along with their protection level.
<li>Outputs documentation in on-line format (HTML and UNIX man page) and
off-line format (\f$\mbox{\LaTeX}\f$) and RTF simultaniously
- (any one can be disabled if desired). Both formats are optimized for
+ (any of these can be disabled if desired). All 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
@@ -54,9 +56,6 @@
generated automatically.
<li>Includes a fast, rank based search engine to search for strings or words
in the class and member documentation.
-<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.
<li>You can type normal HTML tags in your documentation. Doxygen will convert
them to their equivalent \f$\mbox{\LaTeX}\f$ and man-page
counterparts automatically.
@@ -69,8 +68,9 @@
looking into the implementation details.
<li>Allows automatic cross-referencing of (documented) entities with their
definition in the source code.
+<li>All source code fragments are syntax highlighted for ease of reading.
<li>Allows inclusion of function/member/class definitions in the documentation.
-<li>All options are read from an easy to edit and documented
+<li>All options are read from an easy to edit and (optionally) annotated
configuration file.
<li>Documentation and search engine can be transferred to another
location or machine without regenerating the documentation.