summaryrefslogtreecommitdiffstats
path: root/doc/features.doc
diff options
context:
space:
mode:
Diffstat (limited to 'doc/features.doc')
-rw-r--r--doc/features.doc32
1 files changed, 25 insertions, 7 deletions
diff --git a/doc/features.doc b/doc/features.doc
index b1ebf0c..c1615ec 100644
--- a/doc/features.doc
+++ b/doc/features.doc
@@ -21,30 +21,41 @@
<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/C++, Java, (Corba and Microsoft) Java, Python,
- IDL, C#, Objective-C and to some extent D and PHP sources.
+<li>Cross platform: works on Windows and many Unices (including Linux and
+ MacOSX).
+<li>Indexes, organizes and generates browsable and cross-referenced
+ output even from undocumented code.
+<li>Generates structured XML output for parsed sources, which can be
+ used by external tools.
+<li>Supports C/C++, Java, (Corba and Microsoft) Java, Python, VHDL, PHP
+ IDL, C#, Objective-C 2.0, and to some extent D and Fortran sources.
<li>Supports documentation of files, namespaces, packages, classes,
structs, unions, templates, variables, functions, typedefs, enums and
defines.
-<li>JavaDoc (1.1), Qt-Doc, and ECMA-334 (C# spec.) compatible.
+<li>JavaDoc (1.1), qdoc3 (partially), and ECMA-334 (C# spec.) compatible.
+<li>Comes with a GUI frontend (Doxywizard) to ease editing the options and run doxygen.
+ The GUI is available on Windows, Linux, and MacOSX.
<li>Automatically generates class and collaboration diagrams in HTML (as clickable
image maps) and \f$\mbox{\LaTeX}\f$ (as Encapsulated PostScript images).
<li>Uses the dot tool of the Graphviz tool kit to generate
include dependency graphs, collaboration diagrams, call graphs, directory structure
graphs, and graphical class hierarchy graphs.
+<li>Allows grouping of entities in modules and creating a hierarchy of modules.
<li>Flexible comment placement: 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>Generates 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
+<li>Outputs documentation in on-line format (XHTML and UNIX man page) and
off-line format (\f$\mbox{\LaTeX}\f$ and RTF) simultaneously
(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
from the \f$\mbox{\LaTeX}\f$ output.
+<li>Support for various third party help formats including HTML Help,
+ docsets, Qt-Help, and eclipse help.
<li>Includes a full C preprocessor to allow proper parsing of conditional
code fragments and to allow expansion of all or part of macros definitions.
<li>Automatically detects public, protected and private sections, as well as
@@ -56,12 +67,14 @@
<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.
+ in the class and member documentation (PHP based).
+<li>Includes an Javascript based live search feature to search for symbols
+ as you type (for small to medium sized projects).
<li>You can type normal HTML tags in your documentation. Doxygen will convert
them to their equivalent \f$\mbox{\LaTeX}\f$, RTF, 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 references to documentation generated for other (doxygen documented)
+ projects (or another part of the same project) in a location independent way.
<li>Allows inclusion of source code examples that are automatically
cross-referenced with the documentation.
<li>Inclusion of undocumented classes is also supported, allowing to quickly
@@ -75,6 +88,11 @@
configuration file.
<li>Documentation and search engine can be transferred to another
location or machine without regenerating the documentation.
+<li>Supports many different character encodings and uses UTF-8 internally and
+ for the generated output.
+<li>Doxygen can generate a layout which you can use and edit to change the
+ layout of each page.
+<li>There more than a 100 configurable options to finetune the output.
<li>Can cope with large projects easily.
</UL>