diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/commands.doc | 7 | ||||
| -rw-r--r-- | doc/config.doc | 15 | ||||
| -rw-r--r-- | doc/faq.doc | 19 | ||||
| -rw-r--r-- | doc/history.doc | 16 | ||||
| -rw-r--r-- | doc/index.doc | 1 | ||||
| -rw-r--r-- | doc/language.doc | 14 | ||||
| -rw-r--r-- | doc/todo.doc | 36 |
7 files changed, 64 insertions, 44 deletions
diff --git a/doc/commands.doc b/doc/commands.doc index 34853af..e817483 100644 --- a/doc/commands.doc +++ b/doc/commands.doc @@ -1057,10 +1057,8 @@ Doxygen. Unrecognized commands are treated as normal text. The second argument specifies the file name of the image. Doxygen will look for files in the paths (or files) that you specified - after the \ref cfg_image_path "IMAGE_PATH" tag and filter those files through the patterns - you specified after the \ref cfg_image_patterns "IMAGE_PATTERNS" tag. - If the image is found it - will be copied to the correct output directory. + after the \ref cfg_image_path "IMAGE_PATH" tag. + If the image is found it will be copied to the correct output directory. If the image name contains spaces you'll have to put quotes (") around it. The third argument can be used to specify the width or height of the @@ -1083,7 +1081,6 @@ Doxygen. Unrecognized commands are treated as normal text. \verbatim IMAGE_PATH = my_image_dir - IMAGE_PATTERNS = *.eps *.gif *.jpg \endverbatim \warning The image format for HTML is limited to what your diff --git a/doc/config.doc b/doc/config.doc index f46964b..5add2e7 100644 --- a/doc/config.doc +++ b/doc/config.doc @@ -88,7 +88,6 @@ followed by the descriptions of the tags grouped by category. <li> \refitem cfg_html_output HTML_OUTPUT <li> \refitem cfg_html_stylesheet HTML_STYLESHEET <li> \refitem cfg_image_path IMAGE_PATH -<li> \refitem cfg_image_patterns IMAGE_PATTERNS <li> \refitem cfg_include_path INCLUDE_PATH <li> \refitem cfg_inherit_docs INHERIT_DOCS <li> \refitem cfg_inline_info INLINE_INFO @@ -115,6 +114,7 @@ followed by the descriptions of the tags grouped by category. <li> \refitem cfg_searchengine SEARCHENGINE <li> \refitem cfg_source_browser SOURCE_BROWSER <li> \refitem cfg_strip_from_path STRIP_FROM_PATH +<li> \refitem cfg_tab_size TAB_SIZE <li> \refitem cfg_tagfiles TAGFILES <li> \refitem cfg_verbatim_headers VERBATIM_HEADERS <li> \refitem cfg_warnings WARNINGS @@ -314,6 +314,11 @@ followed by the descriptions of the tags grouped by category. If the \c INLINE_INFO tag is set to \c YES (the default) then a tag [inline] is inserted in the documentation for inline members. +\anchor cfg_tab_size +<dt>\c TAB_SIZE <dd> + the TAB_SIZE tag can be used to set the number of spaces in a tab. + Doxygen uses this value to replace tabs by spaces in code fragments. + </dl> \subsection config_input Input related options @@ -382,14 +387,6 @@ followed by the descriptions of the tags grouped by category. directories that contain images that are to be included in the documentation (see the \ref cmdimage "\image" command). -\anchor cfg_image_patterns -<dt>\c IMAGE_PATTERNS <dd> - \addindex IMAGE_PATTERNS - If the value of the \c IMAGE_PATH tag contains directories, you can use the - \c IMAGE_PATTERNS tag to specify one or more wildcard pattern (like *.gif - and *.eps) to filter out the image files in the directories. If left - blank all files are included. - \anchor cfg_input_filter <dt>\c INPUT_FILTER <dd> \addindex INPUT_FILTER diff --git a/doc/faq.doc b/doc/faq.doc index 3d936fe..123671f 100644 --- a/doc/faq.doc +++ b/doc/faq.doc @@ -56,6 +56,25 @@ as <code>PREPROCESSING = YES</code>. Look at section \ref preprocessing for the answer. +<li><b>How can I change what's after the <code>#include</code> in class documentation?</b> + +You can document your class like + +\verbatim +/*! \class MyClassName include.h path/include.h + * + * Docs for MyClassName + */ +\endverbatim + +To make doxygen put <br><br> +<code> +#include <path/include.h> +</code> + +in the documentation of the class MyClassName regardless of the name of the actual +header file in which the definition of MyClassName is contained. + </ol> */ diff --git a/doc/history.doc b/doc/history.doc index ff29e7c..dce7d93 100644 --- a/doc/history.doc +++ b/doc/history.doc @@ -14,24 +14,8 @@ * */ - /*! \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>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 1.0</h3> <ul> <li>Include LaTeX style formulas in LaTeX and HTML output (in HTML as a gif). diff --git a/doc/index.doc b/doc/index.doc index 5684f6c..efbcfe7 100644 --- a/doc/index.doc +++ b/doc/index.doc @@ -184,6 +184,7 @@ Patrick Alberts, Jacques Tremblay, John Sturton, Moshe Kruger, +David Wong, and many others for suggestions, patches and bug reports. </ul> */ diff --git a/doc/language.doc b/doc/language.doc index 96afee0..2eeabf9 100644 --- a/doc/language.doc +++ b/doc/language.doc @@ -102,18 +102,6 @@ Here is a list of the languages and their current maintainers: </TR> <TR BGCOLOR="#ffffff"> <TD> - Polish - </TD> - <TD> - Piotr Piatkowski - </TD> - <TD> - <a href="mailto:kompas@NOSPAM.ceti.com.pl"> - kompas@NOSPAM.ceti.com.pl</a> - </TD> - </TR> - <TR BGCOLOR="#ffffff"> - <TD> Italian </TD> <TD> @@ -209,8 +197,6 @@ Here is a list of the languages and their current maintainers: \hline Romanian & Ionutz Borcoman & {\tt borco@borco-ei.eng.hokudai.ac.jp} \\ \hline - Polish & Piotr Piatkowski & {\tt kompas@ceti.com.pl} \\ - \hline Italian & Ahmed Aldo Faisal & {\tt aaf23@cam.ac.uk} \\ & Alessandro Falappa & {\tt a.falappa@flashnet.it} \\ \hline diff --git a/doc/todo.doc b/doc/todo.doc new file mode 100644 index 0000000..1498ef1 --- /dev/null +++ b/doc/todo.doc @@ -0,0 +1,36 @@ +/****************************************************************************** + * + * $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 todo Doxygen TODO's + +<h3>TODO/Wish list</h3> +<ul> +<li>Expand namespaces in the file docs with the contents that are + specific to the file (maybe also expand the classes inside a namespace). +<li>Add support for grouping members, and document then as a group. +<li>Support for K&R-style function arguments. +<li>More output formats: suggested are info format and RTF format. +<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> + +*/ |