diff options
Diffstat (limited to 'doc/index.doc')
-rw-r--r-- | doc/index.doc | 24 |
1 files changed, 20 insertions, 4 deletions
diff --git a/doc/index.doc b/doc/index.doc index efbcfe7..640129b 100644 --- a/doc/index.doc +++ b/doc/index.doc @@ -33,7 +33,10 @@ 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. +See the +<a href="http://www.gnu.org/copyleft/gpl.html"> +GNU General Public License</a> +for more details. <p> All output generated by Doxygen is not covered by this license. @@ -41,11 +44,13 @@ All output generated by Doxygen is not covered by this license. Doxygen is a documentation system for C and C++. It can generate an on-line class browser (in HTML) and/or an off-line reference manual (in \f$\mbox{\LaTeX}\f$) from a set -of documented source files. There is also some support for generating -man pages. The documentation is extracted directly from the +of documented source files. There is also support for generating +man pages and for converting the generated output into +Postscript, hyperlinked PDF or compressed HTML. +The documentation is extracted directly from the sources. Doxygen is developed on a <a href="http://www.linux.org">Linux</a> platform, but it runs on most other UNIX flavors as well. -An executable for Windows 95/NT is also available. +An executable for Windows 9x/NT is also available. Doxygen can also be configured to extract the code-structure from undocumented source files. This can be very useful to quickly find your way in large @@ -106,6 +111,17 @@ list of projects that use doxygen (see {\tt http://www.stack.nl/$\sim$dimitri/do \endlatexonly If you know other projects, let me know and I'll add them. +<h2>Future work</h2> +Although doxygen is used successfully by a lot of people already, +there is always room for improvement. Therefore, I have compiled a +\htmlonly +<a href="http://www.stack.nl/~dimitri/doxygen/todo.html">todo/wish list</a> +\endhtmlonly +\latexonly +todo/wish list (see {\tt http://www.stack.nl/$\sim$dimitri/doxygen/todo.html}) +\endlatexonly +of possible and/or requested enhancements. + <h2>Acknowledgements</h2> \addindex acknowledgements Thanks go to: |