diff options
Diffstat (limited to 'doc')
-rw-r--r-- | doc/Makefile.in | 2 | ||||
-rw-r--r-- | doc/Makefile.latex | 2 | ||||
-rw-r--r-- | doc/Makefile.win_make.in | 2 | ||||
-rw-r--r-- | doc/Makefile.win_nmake.in | 2 | ||||
-rw-r--r-- | doc/arch.doc | 2 | ||||
-rw-r--r-- | doc/autolink.doc | 2 | ||||
-rw-r--r-- | doc/commands.doc | 15 | ||||
-rw-r--r-- | doc/config.doc | 21 | ||||
-rw-r--r-- | doc/diagrams.doc | 5 | ||||
-rw-r--r-- | doc/docblocks.doc | 2 | ||||
-rw-r--r-- | doc/doxygen.1 | 2 | ||||
-rw-r--r-- | doc/doxygen.sty | 6 | ||||
-rw-r--r-- | doc/doxygen_manual.tex | 4 | ||||
-rw-r--r-- | doc/doxygen_usage.doc | 2 | ||||
-rw-r--r-- | doc/doxytag_usage.doc | 2 | ||||
-rw-r--r-- | doc/doxywizard_usage.doc | 2 | ||||
-rw-r--r-- | doc/external.doc | 2 | ||||
-rw-r--r-- | doc/faq.doc | 2 | ||||
-rw-r--r-- | doc/features.doc | 2 | ||||
-rw-r--r-- | doc/formulas.doc | 2 | ||||
-rw-r--r-- | doc/grouping.doc | 2 | ||||
-rw-r--r-- | doc/history.doc | 2 | ||||
-rw-r--r-- | doc/htmlcmds.doc | 2 | ||||
-rw-r--r-- | doc/index.doc | 4 | ||||
-rw-r--r-- | doc/install.doc | 2 | ||||
-rw-r--r-- | doc/installdox_usage.doc | 2 | ||||
-rw-r--r-- | doc/language.doc | 2 | ||||
-rw-r--r-- | doc/language.tpl | 2 | ||||
-rw-r--r-- | doc/output.doc | 2 | ||||
-rw-r--r-- | doc/preprocessing.doc | 2 | ||||
-rw-r--r-- | doc/starting.doc | 2 | ||||
-rw-r--r-- | doc/trouble.doc | 2 | ||||
-rw-r--r-- | doc/xmlcmds.doc | 2 |
33 files changed, 72 insertions, 37 deletions
diff --git a/doc/Makefile.in b/doc/Makefile.in index a43ad24..e813ff8 100644 --- a/doc/Makefile.in +++ b/doc/Makefile.in @@ -1,7 +1,7 @@ # # # -# Copyright (C) 1997-2004 by Dimitri van Heesch. +# Copyright (C) 1997-2006 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 diff --git a/doc/Makefile.latex b/doc/Makefile.latex index c460700..414d44f 100644 --- a/doc/Makefile.latex +++ b/doc/Makefile.latex @@ -1,7 +1,7 @@ # # # -# Copyright (C) 1997-2004 by Dimitri van Heesch. +# Copyright (C) 1997-2006 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 diff --git a/doc/Makefile.win_make.in b/doc/Makefile.win_make.in index 3d5248e..7d825df 100644 --- a/doc/Makefile.win_make.in +++ b/doc/Makefile.win_make.in @@ -1,7 +1,7 @@ # # # -# Copyright (C) 1997-2004 by Dimitri van Heesch. +# Copyright (C) 1997-2006 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 diff --git a/doc/Makefile.win_nmake.in b/doc/Makefile.win_nmake.in index b20bee9..d1b6bb3 100644 --- a/doc/Makefile.win_nmake.in +++ b/doc/Makefile.win_nmake.in @@ -1,7 +1,7 @@ # # # -# Copyright (C) 1997-2004 by Dimitri van Heesch. +# Copyright (C) 1997-2006 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 diff --git a/doc/arch.doc b/doc/arch.doc index a5ace10..5a431e2 100644 --- a/doc/arch.doc +++ b/doc/arch.doc @@ -2,7 +2,7 @@ * * * - * Copyright (C) 1997-2005 by Dimitri van Heesch. + * Copyright (C) 1997-2006 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 diff --git a/doc/autolink.doc b/doc/autolink.doc index 1dbeda7..5ddd4df 100644 --- a/doc/autolink.doc +++ b/doc/autolink.doc @@ -2,7 +2,7 @@ * * * - * Copyright (C) 1997-2005 by Dimitri van Heesch. + * Copyright (C) 1997-2006 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 diff --git a/doc/commands.doc b/doc/commands.doc index 391e4f7..fa076c8 100644 --- a/doc/commands.doc +++ b/doc/commands.doc @@ -2,7 +2,7 @@ * * * - * Copyright (C) 1997-2005 by Dimitri van Heesch. + * Copyright (C) 1997-2006 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 @@ -48,6 +48,7 @@ documentation: \refitem cmdbug \\bug \refitem cmdc \\c \refitem cmdcallgraph \\callgraph +\refitem cmdcallergraph \\callergraph \refitem cmdcategory \\category \refitem cmdclass \\class \refitem cmdcode \\code @@ -218,6 +219,18 @@ doxygen. Unrecognized commands are treated as normal text. doxygen code parser which is not perfect. <hr> +\section cmdcallergraph \\callergraph + + \addindex \\callergraph + When this command is put in a comment block of a function or method + and \ref cfg_have_dot "HAVE_DOT" is set to YES, then doxygen will + generate a caller graph for that function (provided the implementation of the + function or method calls other documented functions). The caller graph will + generated regardless of the value of \ref cfg_caller_graph "CALLER_GRAPH". + \note The completeness (and correctness) of the caller graph depends on the + doxygen code parser which is not perfect. + +<hr> \section cmdcategory \\category <name> [<header-file>] [<header-name>] \addindex \\category diff --git a/doc/config.doc b/doc/config.doc index 891f148..75cf0dd 100644 --- a/doc/config.doc +++ b/doc/config.doc @@ -2,7 +2,7 @@ * * * - * Copyright (C) 1997-2005 by Dimitri van Heesch. + * Copyright (C) 1997-2006 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 @@ -64,6 +64,7 @@ followed by the descriptions of the tags grouped by category. \refitem cfg_builtin_stl_support BUILTIN_STL_SUPPORT \refitem cfg_brief_member_desc BRIEF_MEMBER_DESC \refitem cfg_call_graph CALL_GRAPH +\refitem cfg_caller_graph CALLER_GRAPH \refitem cfg_case_sense_names CASE_SENSE_NAMES \refitem cfg_chm_file CHM_FILE \refitem cfg_class_diagrams CLASS_DIAGRAMS @@ -180,6 +181,7 @@ followed by the descriptions of the tags grouped by category. \refitem cfg_recursive RECURSIVE \refitem cfg_referenced_by_relation REFERENCED_BY_RELATION \refitem cfg_references_relation REFERENCES_RELATION +\refitem cfg_references_link_source REFERENCES_LINK_SOURCE \refitem cfg_repeat_brief REPEAT_BRIEF \refitem cfg_rtf_extensions_file RTF_EXTENSIONS_FILE \refitem cfg_rtf_hyperlinks RTF_HYPERLINKS @@ -919,6 +921,14 @@ FILE_VERSION_INFO = "cleartool desc -fmt \%Vn" then for each documented function all documented entities called/used by that function will be listed. +\anchor cfg_references_link_source +<dt>\c REFERENCES_LINK_SOURCE <dd> + \addindex REFERENCES_LINK_SOURCE + If the \c REFERENCES_LINK_SOURCE tag is set to \c YES (the default) + and SOURCE_BROWSER tag is set to \c YES, then the hyperlinks from + functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will + link to the source code. Otherwise they will link to the documentstion. + \anchor cfg_verbatim_headers <dt>\c VERBATIM_HEADERS <dd> \addindex VERBATIM_HEADERS @@ -1688,6 +1698,15 @@ TAGFILES = file1=loc1 "file2 = loc2" ... </pre> So in most cases it will be better to enable call graphs for selected functions only using the \\callgraph command. +\anchor cfg_caller_graph +<dt>\c CALLER_GRAPH <dd> + \addindex CALLER_GRAPH + If the \c CALLER_GRAPH and \c HAVE_DOT tags are set to \c YES then doxygen will + generate a caller dependency graph for every global function or class method. + Note that enabling this option will significantly increase the time of a run. + So in most cases it will be better to enable caller graphs for selected + functions only using the \\callergraph command. + \anchor cfg_graphical_hierarchy <dt>\c GRAPHICAL_HIERARCHY <dd> \addindex GRAPHICAL_HIERARCHY diff --git a/doc/diagrams.doc b/doc/diagrams.doc index 7b3c46e..41ff4f9 100644 --- a/doc/diagrams.doc +++ b/doc/diagrams.doc @@ -2,7 +2,7 @@ * * * - * Copyright (C) 1997-2005 by Dimitri van Heesch. + * Copyright (C) 1997-2006 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 @@ -55,6 +55,9 @@ <li>if \ref cfg_call_graph "CALL_GRAPH" is set to YES, a graphical call graph is drawn for each function showing the functions that the function directly or indirectly calls. + <li>if \ref cfg_caller_graph "CALLER_GRAPH" is set to YES, a + graphical caller graph is drawn for each function showing the + functions that the function is directly or indirectly called by. </ul> The elements in the class diagrams in HTML and RTF diff --git a/doc/docblocks.doc b/doc/docblocks.doc index 10f6801..9be933e 100644 --- a/doc/docblocks.doc +++ b/doc/docblocks.doc @@ -2,7 +2,7 @@ * * * - * Copyright (C) 1997-2005 by Dimitri van Heesch. + * Copyright (C) 1997-2006 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 diff --git a/doc/doxygen.1 b/doc/doxygen.1 index fc4ccd8..157a924 100644 --- a/doc/doxygen.1 +++ b/doc/doxygen.1 @@ -41,6 +41,6 @@ doxygen \fB\-e\fR rtf extensionsFile If \fB\-s\fR is specified the comments in the config file will be omitted. If configName is omitted `Doxyfile' will be used as a default. .SH AUTHOR -Doxygen version VERSION, Copyright Dimitri van Heesch 1997-2005 +Doxygen version VERSION, Copyright Dimitri van Heesch 1997-2006 .SH SEE ALSO doxytag(1), doxywizard(1). diff --git a/doc/doxygen.sty b/doc/doxygen.sty index ce75b30..3d0292b 100644 --- a/doc/doxygen.sty +++ b/doc/doxygen.sty @@ -1,7 +1,7 @@ % % % -% Copyright (C) 1997-2004 by Dimitri van Heesch. +% Copyright (C) 1997-2006 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 @@ -24,8 +24,8 @@ {\fancyplain{}{\bfseries\rightmark}} \rhead[\fancyplain{}{\bfseries\leftmark}] {\fancyplain{}{\bfseries\thepage}} -\rfoot[\fancyplain{}{\bfseries\scriptsize User Manual for Doxygen $VERSION, written by Dimitri van Heesch \copyright 1997-2004}]{} -\lfoot[]{\fancyplain{}{\bfseries\scriptsize User Manual for Doxygen $VERSION, written by Dimitri van Heesch \copyright 1997-2004}} +\rfoot[\fancyplain{}{\bfseries\scriptsize User Manual for Doxygen $VERSION, written by Dimitri van Heesch \copyright 1997-2006}]{} +\lfoot[]{\fancyplain{}{\bfseries\scriptsize User Manual for Doxygen $VERSION, written by Dimitri van Heesch \copyright 1997-2006}} \cfoot{} \newenvironment{Code} {\footnotesize} diff --git a/doc/doxygen_manual.tex b/doc/doxygen_manual.tex index 8d5d178..a50ec7a 100644 --- a/doc/doxygen_manual.tex +++ b/doc/doxygen_manual.tex @@ -1,7 +1,7 @@ % % % -% Copyright (C) 1997-2004 by Dimitri van Heesch. +% Copyright (C) 1997-2006 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 @@ -37,7 +37,7 @@ \begin{center} Manual for version $VERSION\\[2ex] Written by Dimitri van Heesch\\[2ex] -\copyright 1997-2004 +\copyright 1997-2006 \end{center} \end{titlepage} \clearemptydoublepage diff --git a/doc/doxygen_usage.doc b/doc/doxygen_usage.doc index 18773e5..c6b07b3 100644 --- a/doc/doxygen_usage.doc +++ b/doc/doxygen_usage.doc @@ -2,7 +2,7 @@ * * * - * Copyright (C) 1997-2005 by Dimitri van Heesch. + * Copyright (C) 1997-2006 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 diff --git a/doc/doxytag_usage.doc b/doc/doxytag_usage.doc index 2d5d5ea..dfb7ffb 100644 --- a/doc/doxytag_usage.doc +++ b/doc/doxytag_usage.doc @@ -2,7 +2,7 @@ * * * - * Copyright (C) 1997-2005 by Dimitri van Heesch. + * Copyright (C) 1997-2006 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 diff --git a/doc/doxywizard_usage.doc b/doc/doxywizard_usage.doc index c678c81..cf9ad10 100644 --- a/doc/doxywizard_usage.doc +++ b/doc/doxywizard_usage.doc @@ -2,7 +2,7 @@ * * * - * Copyright (C) 1997-2005 by Dimitri van Heesch. + * Copyright (C) 1997-2006 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 diff --git a/doc/external.doc b/doc/external.doc index 9e156d1..e17ec2c 100644 --- a/doc/external.doc +++ b/doc/external.doc @@ -2,7 +2,7 @@ * * * - * Copyright (C) 1997-2005 by Dimitri van Heesch. + * Copyright (C) 1997-2006 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 diff --git a/doc/faq.doc b/doc/faq.doc index 98fe635..c9f43d2 100644 --- a/doc/faq.doc +++ b/doc/faq.doc @@ -2,7 +2,7 @@ * * * - * Copyright (C) 1997-2005 by Dimitri van Heesch. + * Copyright (C) 1997-2006 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 diff --git a/doc/features.doc b/doc/features.doc index 871242d..b53ddcb 100644 --- a/doc/features.doc +++ b/doc/features.doc @@ -2,7 +2,7 @@ * * * - * Copyright (C) 1997-2005 by Dimitri van Heesch. + * Copyright (C) 1997-2006 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 diff --git a/doc/formulas.doc b/doc/formulas.doc index be6438c..cde7f06 100644 --- a/doc/formulas.doc +++ b/doc/formulas.doc @@ -2,7 +2,7 @@ * * * - * Copyright (C) 1997-2005 by Dimitri van Heesch. + * Copyright (C) 1997-2006 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 diff --git a/doc/grouping.doc b/doc/grouping.doc index 6e942ce..ec3072b 100644 --- a/doc/grouping.doc +++ b/doc/grouping.doc @@ -2,7 +2,7 @@ * * * - * Copyright (C) 1997-2005 by Dimitri van Heesch. + * Copyright (C) 1997-2006 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 diff --git a/doc/history.doc b/doc/history.doc index 6c241e5..9ba453d 100644 --- a/doc/history.doc +++ b/doc/history.doc @@ -2,7 +2,7 @@ * * * - * Copyright (C) 1997-2005 by Dimitri van Heesch. + * Copyright (C) 1997-2006 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 diff --git a/doc/htmlcmds.doc b/doc/htmlcmds.doc index 18422de..0403edb 100644 --- a/doc/htmlcmds.doc +++ b/doc/htmlcmds.doc @@ -2,7 +2,7 @@ * * * - * Copyright (C) 1997-2005 by Dimitri van Heesch. + * Copyright (C) 1997-2006 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 diff --git a/doc/index.doc b/doc/index.doc index d4d0493..bb91d59 100644 --- a/doc/index.doc +++ b/doc/index.doc @@ -2,7 +2,7 @@ * * * - * Copyright (C) 1997-2005 by Dimitri van Heesch. + * Copyright (C) 1997-2006 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 @@ -115,7 +115,7 @@ The third part provides information for developers: \addindex license \addindex GPL -Copyright © 1997-2005 by +Copyright © 1997-2006 by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>.<p> Permission to use, copy, modify, and distribute this software and its diff --git a/doc/install.doc b/doc/install.doc index 1003df4..d424100 100644 --- a/doc/install.doc +++ b/doc/install.doc @@ -2,7 +2,7 @@ * * * - * Copyright (C) 1997-2005 by Dimitri van Heesch. + * Copyright (C) 1997-2006 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 diff --git a/doc/installdox_usage.doc b/doc/installdox_usage.doc index 4f05d45..05784ec 100644 --- a/doc/installdox_usage.doc +++ b/doc/installdox_usage.doc @@ -2,7 +2,7 @@ * * * - * Copyright (C) 1997-2005 by Dimitri van Heesch. + * Copyright (C) 1997-2006 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 diff --git a/doc/language.doc b/doc/language.doc index 106c645..05beecc 100644 --- a/doc/language.doc +++ b/doc/language.doc @@ -1,7 +1,7 @@ /****************************************************************************** * Do not edit this file. It was generated by the translator.py script. * - * Copyright (C) 1997-2004 by Dimitri van Heesch. + * Copyright (C) 1997-2006 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 diff --git a/doc/language.tpl b/doc/language.tpl index d8cc0d3..dea2252 100644 --- a/doc/language.tpl +++ b/doc/language.tpl @@ -5,7 +5,7 @@ change the language.doc, make the changes here and inside maintainers.txt. /****************************************************************************** * %(editnote)s * - * Copyright (C) 1997-2004 by Dimitri van Heesch. + * Copyright (C) 1997-2006 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 diff --git a/doc/output.doc b/doc/output.doc index 73e6916..ec382bd 100644 --- a/doc/output.doc +++ b/doc/output.doc @@ -2,7 +2,7 @@ * * * - * Copyright (C) 1997-2005 by Dimitri van Heesch. + * Copyright (C) 1997-2006 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 diff --git a/doc/preprocessing.doc b/doc/preprocessing.doc index f56d816..851d36c 100644 --- a/doc/preprocessing.doc +++ b/doc/preprocessing.doc @@ -2,7 +2,7 @@ * * * - * Copyright (C) 1997-2005 by Dimitri van Heesch. + * Copyright (C) 1997-2006 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 diff --git a/doc/starting.doc b/doc/starting.doc index b30978f..ef7331f 100644 --- a/doc/starting.doc +++ b/doc/starting.doc @@ -2,7 +2,7 @@ * * * - * Copyright (C) 1997-2005 by Dimitri van Heesch. + * Copyright (C) 1997-2006 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 diff --git a/doc/trouble.doc b/doc/trouble.doc index dc3fbbd..ac612c7 100644 --- a/doc/trouble.doc +++ b/doc/trouble.doc @@ -2,7 +2,7 @@ * * * - * Copyright (C) 1997-2005 by Dimitri van Heesch. + * Copyright (C) 1997-2006 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 diff --git a/doc/xmlcmds.doc b/doc/xmlcmds.doc index f6440ef..79d47df 100644 --- a/doc/xmlcmds.doc +++ b/doc/xmlcmds.doc @@ -2,7 +2,7 @@ * * * - * Copyright (C) 1997-2005 by Dimitri van Heesch. + * Copyright (C) 1997-2006 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 |