/******************************************************************************
*
* $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
TODO/Wish list
- Add support for grouping members, and document then as a group.
- Support for K&R-style function arguments.
- More ouput formats: suggested are info format and RTF format.
- Reintroduction of the multi-column class list (and file list) to quickly
select a class or file
- Split long lists in an index to a set of smaller lists.
- Add a nice graphical front-end for creating and modifying the
configuration file (it should be flexible enough to quickly add new options).
- Improve the search index generation, so it uses less memory and
is easier to get running.
- Generate code metrics (Anyone know a good book about code metrics?)
- Add features that you think are missing... So if you know any that are
not yet listed here, please let me know.
Features scheduled for version 0.5
- Proper support for namespaces.
- Include LaTeX style formulas in LaTeX and HTML output (in HTML as a gif).
- Proper support for template classes, members, functions and specializations.
- Multi-lingual support.
- Generation of class diagrams (clickable image maps in HTML, eps images in
postscript).
- Add generator for man pages format.
Version 0.4
New features:
- LaTeX output generation.
- Full JavaDoc support.
- Build-in C-preprocessor for correct conditional parsing of source code
that is read by Doxygen.
- Build-in HTML to LaTeX converter. This allows you to use HTML tags in
your documentation, while doxygen still generates proper LaTeX output.
- 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.
- Enum types, enum values, typedefs, #defines, and files can now be
documented.
- Completely new documentation, that is now generated by Doxygen.
- A lot of small examples are now included.
Bug fixes:
- A lot of parser bugs are fixed.
- Improved support for documenting C code.
Version 0.3
New features:
- A search engine doxysearch,
that allows you to search through the generated documentation.
- A configuration file instead of command-line options. A default
configuration file can be generated
by doxygen.
- Added an option to generate output for undocumented classes.
- Added an option to generate output for private members.
- Every page now contains a condensed index page, allowing much faster
navigation through the documentation.
- Global and member variables can now be documented.
- A project name can now given, which will be included in the
documentation.
Bug fixes:
- Fixed bug when files with the same name but in different directories
are used as include files.
- Template classes now work.
- Inner classes now work.
- Fixed a bug regarding unrelated functions and
\fn
.
- Fixed parse bug with
/**/
comments
- Fixed a bug regarding inline friend functions.
- The list of all members now also contains the undocumented members.
- Special documentation is now removed from code blocks.
- Doxygen should compile on Sun Solaris (with
CC
), HP-UX (with
CC
), Irix (with DCC) and Linux (with GCC
)
- Fixed several minor bugs.
Version 0.2
New features:
- Blocks of code are now parsed. Function calls and variables are
replaced by links to their documentation if possible.
- Special example documentation block added. This can be used to
provide cross references between the documentation and some example code.
- Documentation blocks can now be placed inside the body of a class.
- Documentation blocks with line range may now be created using
special
//!
C++ line comments.
- Unrelated members can now be documented. A page containing a
list of these members is generated.
- Added an
\include
command to insert blocks of source code
into the documentation.
- Warnings are generated for members that are undocumented.
- You can now specify your own HTML headers and footers for the
generated pages.
- Option added to generated indices containing all external classes
instead of only the used ones.
Bug fixes:
- Fixed a link generation problem with mixed case filenames are used.
- Made doxygen a little more portable.
(doxygen should now compile on Linux (with g++) and HP-UX (with CC))
- Fixed a bug in err() function.
- Fixed a problem with the type cast operator.
- Removed some typo's from the docs.
- Several small bug fixes and enhancements.
Version 0.1
Initial version.
*/