features.doc 6.44 KB
Newer Older
Dimitri van Heesch's avatar
Dimitri van Heesch committed
1 2
/******************************************************************************
 *
3
 * 
Dimitri van Heesch's avatar
Dimitri van Heesch committed
4
 *
Dimitri van Heesch's avatar
Dimitri van Heesch committed
5
 * Copyright (C) 1997-2013 by Dimitri van Heesch.
Dimitri van Heesch's avatar
Dimitri van Heesch committed
6 7 8 9 10 11 12
 *
 * Permission to use, copy, modify, and distribute this software and its
 * documentation under the terms of the GNU General Public License is hereby 
 * granted. No representations are made about the suitability of this software 
 * for any purpose. It is provided "as is" without express or implied warranty.
 * See the GNU General Public License for more details.
 *
Dimitri van Heesch's avatar
Dimitri van Heesch committed
13 14
 * Documents produced by Doxygen are derivative works derived from the
 * input used in their production; they are not affected by this license.
Dimitri van Heesch's avatar
Dimitri van Heesch committed
15 16
 *
 */
Dimitri van Heesch's avatar
Dimitri van Heesch committed
17
/*! \page features Features
Dimitri van Heesch's avatar
Dimitri van Heesch committed
18 19 20 21

\addindex features
<UL>
<li>Requires very little overhead from the writer of the documentation. 
22 23 24 25
    Plain text will do, Markdown is support, and for more fancy or 
    structured output HTML tags and/or some of doxygen's special commands 
    can be used.
<li>Cross platform: works on Windows and many Unix flavors (including Linux and
Dimitri van Heesch's avatar
Dimitri van Heesch committed
26 27 28 29 30 31
    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
32
    IDL, C#, Fortran, TCL, Objective-C 2.0, and to some extent D sources.
33 34 35
<li>Supports documentation of files, namespaces, packages, classes, 
    structs, unions, templates, variables, functions, typedefs, enums and 
    defines. 
Dimitri van Heesch's avatar
Dimitri van Heesch committed
36
<li>JavaDoc (1.1), qdoc3 (partially), and ECMA-334 (C# spec.) compatible.
37 38
<li>Comes with a GUI frontend (Doxywizard) to ease editing the options and 
    run doxygen. The GUI is available on Windows, Linux, and MacOSX.
39
<li>Automatically generates class and collaboration diagrams in HTML (as clickable 
Dimitri van Heesch's avatar
Dimitri van Heesch committed
40
    image maps) and \f$\mbox{\LaTeX}\f$ (as Encapsulated PostScript images).
41
<li>Uses the `dot` tool of the Graphviz tool kit to generate
Dimitri van Heesch's avatar
Dimitri van Heesch committed
42 43
    include dependency graphs, collaboration diagrams, call graphs, directory structure
    graphs, and graphical class hierarchy graphs. 
Dimitri van Heesch's avatar
Dimitri van Heesch committed
44
<li>Allows grouping of entities in modules and creating a hierarchy of modules.
45 46
<li>Flexible comment placement: Allows you to put documentation in the 
    header file (before the 
47 48
    declaration of an entity), source file (before the definition of an entity) 
    or in a separate file.
49
<li>Generates a list of all members of a class (including any inherited
50
    members) along with their protection level.
Dimitri van Heesch's avatar
Dimitri van Heesch committed
51
<li>Outputs documentation in on-line format (XHTML and UNIX man page) and 
Dimitri van Heesch's avatar
Dimitri van Heesch committed
52
    off-line format (\f$\mbox{\LaTeX}\f$ and RTF) simultaneously 
53
    (any of these can be disabled if desired). All formats are optimized for 
54 55
    ease of reading. <br>
    Furthermore, compressed HTML can be generated from HTML output using 
Dimitri van Heesch's avatar
Dimitri van Heesch committed
56
    Microsoft's HTML Help Workshop (Windows only) and PDF can be generated 
57
    from the \f$\mbox{\LaTeX}\f$ output.
Dimitri van Heesch's avatar
Dimitri van Heesch committed
58 59
<li>Support for various third party help formats including HTML Help,
    docsets, Qt-Help, and eclipse help.
Dimitri van Heesch's avatar
Dimitri van Heesch committed
60
<li>Includes a full C preprocessor to allow proper parsing of conditional 
61
    code fragments and to allow expansion of all or part of macros definitions.
Dimitri van Heesch's avatar
Dimitri van Heesch committed
62 63 64
<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.
65
<li>Automatically generates references to documented classes, files, namespaces
66
    and members. Documentation of global functions, global variables, 
67
    typedefs, defines and enumerations is also supported.
Dimitri van Heesch's avatar
Dimitri van Heesch committed
68 69 70
<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 
Dimitri van Heesch's avatar
Dimitri van Heesch committed
71 72 73
    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).
Dimitri van Heesch's avatar
Dimitri van Heesch committed
74
<li>You can type normal HTML tags in your documentation. Doxygen will convert
Dimitri van Heesch's avatar
Dimitri van Heesch committed
75
    them to their equivalent \f$\mbox{\LaTeX}\f$, RTF, and man-page 
76
    counterparts automatically.
Dimitri van Heesch's avatar
Dimitri van Heesch committed
77 78
<li>Allows references to documentation generated for other (doxygen documented) 
    projects (or another part of the same project) in a location independent way.
Dimitri van Heesch's avatar
Dimitri van Heesch committed
79 80 81 82 83
<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
    learn the structure and interfaces of a (large) piece of code without 
    looking into the implementation details.
84 85
<li>Allows automatic cross-referencing of (documented) entities with their
    definition in the source code.
86
<li>All source code fragments are syntax highlighted for ease of reading.
87
<li>Allows inclusion of function/member/class definitions in the documentation.
88
<li>All options are read from an easy to edit and (optionally) annotated 
89
    configuration file.
Dimitri van Heesch's avatar
Dimitri van Heesch committed
90 91
<li>Documentation and search engine can be transferred to another 
    location or machine without regenerating the documentation.
Dimitri van Heesch's avatar
Dimitri van Heesch committed
92 93 94 95
<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.
96
<li>There more than a 100 configurable options to fine-tune the output.
Dimitri van Heesch's avatar
Dimitri van Heesch committed
97 98 99
<li>Can cope with large projects easily.
</UL>

Dimitri van Heesch's avatar
Dimitri van Heesch committed
100 101
Although doxygen can now be used in any project written in a language that is 
supported by doxygen, initially it was specifically designed to be used for projects 
102
that make use of Qt Software's 
103
<A HREF="http://qt-project.org/">Qt toolkit</A>. I have tried to 
Dimitri van Heesch's avatar
Dimitri van Heesch committed
104 105
make doxygen `Qt-compatible'. That is: Doxygen can read the documentation contained in 
the Qt source code and create a class browser that looks quite similar to the 
106
one that is generated by Qt Software. Doxygen understands the C++ extensions 
Dimitri van Heesch's avatar
Dimitri van Heesch committed
107
used by Qt such as signals and slots and many of the markup commands used in the Qt sources.
Dimitri van Heesch's avatar
Dimitri van Heesch committed
108 109 110 111 112 113 114 115

Doxygen can also automatically generate links to existing documentation
that was generated with Doxygen or with Qt's non-public class browser 
generator. For a Qt based project this means that whenever you refer to 
members or classes belonging to the Qt toolkit, a link will be generated to 
the Qt documentation. This is done independent of where this documentation 
is located! 

116 117 118 119 120 121

\htmlonly
Go to the <a href="doxygen_usage.html">next</a> section or return to the
 <a href="index.html">index</a>.
\endhtmlonly

Dimitri van Heesch's avatar
Dimitri van Heesch committed
122
*/