summaryrefslogtreecommitdiffstats
path: root/doc/history.doc
blob: 3571bd61f8bb7955aa3925d2537bc173ba5220a0 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
/******************************************************************************
 *
 * $Id$
 *
 * Copyright (C) 1997-1999 by Dimitri van Heesch.
 *
 * 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.
 *
 * All output generated with Doxygen is not covered by this license.
 *
 */


/*! \page history Doxygen History

<h3>TODO/Wish list</h3>
<ul>
<li>Add support for grouping members, and document then as a group.
<li>Support for K&R-style function arguments.
<li>More ouput formats: suggested are info format and RTF format.
<li>Reintroduction of the multi-column class list (and file list) to quickly 
    select a class or file
<li>Split long lists in an index to a set of smaller lists.
<li>Add a nice graphical front-end for creating and modifying the 
    configuration file (it should be flexible enough to quickly add new options).
<li>Improve the search index generation, so it uses less memory and
    is easier to get running.
<li>Generate code metrics (Anyone know a good book about code metrics?)
<li>Add features that you think are missing... So if you know any that are
    not yet listed here, please let me know.
</ul>

<h3>Features scheduled for version 0.5</h3>
<ul>
<li>Proper support for namespaces.
<li>Include LaTeX style formulas in LaTeX and HTML output (in HTML as a gif).
<li>Proper support for template classes, members, functions and specializations.
<li>Multi-lingual support.
<li>Generation of class diagrams (clickable image maps in HTML, eps images in
    postscript).
<li>Add generator for man pages format.
</ul>

<h3>Version 0.4</h3>

<h4>New features:</h4>
<ul>
<li>LaTeX output generation.
<li>Full JavaDoc support. 
<li>Build-in C-preprocessor for correct conditional parsing of source code
    that is read by Doxygen.
<li>Build-in HTML to LaTeX converter. This allows you to use HTML tags in
    your documentation, while doxygen still generates proper LaTeX output.
<li>Many new commands (there are now more than 60!) to document
    more entities, to make the documentation look nicer, and to include 
    examples or pieces of examples.
<li>Enum types, enum values, typedefs, #defines, and files can now be 
    documented.
<li>Completely new documentation, that is now generated by Doxygen.
<li>A lot of small examples are now included.
</ul>
<h4>Bug fixes:</h4>
<ul>
<li>A lot of parser bugs are fixed.
<li>Improved support for documenting C code.
</ul> 

<h3>Version 0.3</h3>
<h4>New features:</h4>
<ul>
<li>A search engine <a href="doxysearch_usage.html">doxysearch</a>, 
    that allows you to search through the generated documentation.
<li>A configuration file instead of command-line options. A default 
    configuration file can be generated 
    by <a href="doxygen_usage.html">doxygen</a>.
<li>Added an option to generate output for undocumented classes.
<li>Added an option to generate output for private members.
<li>Every page now contains a condensed index page, allowing much faster 
    navigation through the documentation.
<li>Global and member variables can now be documented.
<li>A project name can now given, which will be included in the 
    documentation.
</ul>

<h4>Bug fixes:</h4>
<ul>
<li>Fixed bug when files with the same name but in different directories
    are used as include files.
<li>Template classes now work.
<li>Inner classes now work.
<li>Fixed a bug regarding unrelated functions and <code>\fn</code>.
<li>Fixed parse bug with <code>/**/</code> comments 
<li>Fixed a bug regarding inline friend functions.
<li>The list of all members now also contains the undocumented members.
<li>Special documentation is now removed from code blocks.
<li>Doxygen should compile on Sun Solaris (with <code>CC</code>), HP-UX (with 
    <code>CC</code>), Irix (with DCC) and Linux (with <code>GCC</code>)
<li>Fixed several minor bugs.
</ul>

<h3>Version 0.2</h3>
<h4>New features:</h4>
<ul>
<li>Blocks of code are now parsed. Function calls and variables are
    replaced by links to their documentation if possible.
<li>Special example documentation block added. This can be used to
    provide cross references between the documentation and some example code.
<li>Documentation blocks can now be placed inside the body of a class.
<li>Documentation blocks with line range may now be created using 
    special <code>//!</code> C++ line comments.
<li>Unrelated members can now be documented. A page containing a
    list of these members is generated.
<li>Added an <code>\include</code> command to insert blocks of source code
    into the documentation.
<li>Warnings are generated for members that are undocumented.
<li>You can now specify your own HTML headers and footers for the
    generated pages.
<li>Option added to generated indices containing all external classes
    instead of only the used ones.
</ul>

<h4>Bug fixes:</h4>
<ul>
<li>Fixed a link generation problem with mixed case filenames are used.
<li>Made doxygen a little more portable. 
    (doxygen should now compile on Linux (with g++) and HP-UX (with CC))
<li>Fixed a bug in err() function.
<li>Fixed a problem with the type cast operator.
<li>Removed some typo's from the docs.
<li>Several small bug fixes and enhancements.
</ul>

<h3>Version 0.1</h3>
Initial version.

*/