summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authordimitri <dimitri@afe2bf4a-e733-0410-8a33-86f594647bc7>2000-02-20 17:34:13 (GMT)
committerdimitri <dimitri@afe2bf4a-e733-0410-8a33-86f594647bc7>2000-02-20 17:34:13 (GMT)
commitb76d4ee1ec41101fffbef5d33c5a2ea70a6c6e54 (patch)
treef122ed1db8000e070cab7f8ad4c4af87b89adbe5 /doc
parent8cc2d754b7ad3e3e88f4c1bb92878d8f517076e6 (diff)
downloadDoxygen-b76d4ee1ec41101fffbef5d33c5a2ea70a6c6e54.zip
Doxygen-b76d4ee1ec41101fffbef5d33c5a2ea70a6c6e54.tar.gz
Doxygen-b76d4ee1ec41101fffbef5d33c5a2ea70a6c6e54.tar.bz2
+ The graphical class hierarchy was not properly generated when
template classes were used. + Template specialization could not be documented using the \class command. This is now fixed. Example: /*! * \class T<A,int> * My template specialization of template T. */ + Fixed a bug when parsing M$-IDL code, containing helpstring("bla") attributes. The attributes of a method are no longer shown in the documentation (the attributes of method arguments still visible however). + Improved the search algorithm that tries to connect classes with their base classes. It should now (hopefully) work correct in all cases where nested classes and/or namespaces are used. + Fixed a scanner problem that could cause doxygen to get confused after parsing struct initializers. + the DOTFONTPATH environment variable is now automatically set for Windows. This should make any "missing doxfont.ttf" messages disappear. + the extra LaTeX packages specified with EXTRA_PACKAGES can now also be used when generating formulas for HTML. + The documentation of a parameters that is part of a member definition, is now used in the documentation as well. + Fixed a HTML output bug in the class/file group-pages. + Links to example files generated with \link ... \endlink where not correct. + made the bullet list generation more robust. A space is now required after the - sign. A list can now start a paragraph. + the configure script now detects whether or not dot is installed. + The VERBATIM_HEADERS option didn't have any effect any more. It should now works again as advertised. + The IGNORE_PREFIX option can now also deal with a list of prefixes. + @verbatim ... @endverbatim blocks did not work. + new option SHOW_INCLUDE_FILES, which can be set to NO to turn of the list of include files that is generated for each documented file. + new option STRIP_CODE_COMMENTS, which can be set to NO to keep any special comment blocks in the generated code fragments.
Diffstat (limited to 'doc')
-rw-r--r--doc/config.doc25
-rw-r--r--doc/install.doc2
2 files changed, 21 insertions, 6 deletions
diff --git a/doc/config.doc b/doc/config.doc
index 6e30f89..9bb5b46 100644
--- a/doc/config.doc
+++ b/doc/config.doc
@@ -120,7 +120,9 @@ followed by the descriptions of the tags grouped by category.
<li> \refitem cfg_repeat_brief REPEAT_BRIEF
<li> \refitem cfg_search_includes SEARCH_INCLUDES
<li> \refitem cfg_searchengine SEARCHENGINE
+<li> \refitem cfg_show_include_files SHOW_INCLUDE_FILES
<li> \refitem cfg_source_browser SOURCE_BROWSER
+<li> \refitem cfg_strip_code_comments STRIP_CODE_COMMENTS
<li> \refitem cfg_strip_from_path STRIP_FROM_PATH
<li> \refitem cfg_rtf_hyperlinks RTF_HYPERLINKS
<li> \refitem cfg_rtf_output RTF_OUTPUT
@@ -292,6 +294,13 @@ followed by the descriptions of the tags grouped by category.
Setting the \c INLINE_SOURCES tag to \c YES will include the body
of functions, classes and enums directly into the documentation.
+\anchor cfg_strip_code_comments
+<dt>\c STRIP_CODE_COMMENTS <dd>
+ \addindex STRIP_CODE_COMMENTS
+ Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
+ doxygen to hide any special comment blocks from generated source code
+ fragments. Normal C and C++ comments will always remain visible.
+
\anchor cfg_case_sense_names
<dt>\c CASE_SENSE_NAMES <dd>
\addindex CASE_SENSE_NAMES
@@ -309,6 +318,13 @@ followed by the descriptions of the tags grouped by category.
which an include is specified. Set to NO to disable this.
\sa Section \ref cmdclass "\\class".
+\anchor cfg_show_include_files
+<dt>\c SHOW_INCLUDE_FILES <dd>
+ \addindex SHOW_INCLUDE_FILES
+ If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
+ will put list of the files that are included by a file in the documentation
+ of that file.
+
\anchor cfg_javadoc_autobrief
<dt>\c JAVADOC_AUTOBRIEF <dd>
\addindex JAVADOC_AUTOBRIEF
@@ -559,10 +575,11 @@ used to specify the number of columns in which this list will be split (can be a
\anchor cfg_ignore_prefix
<dt>\c IGNORE_PREFIX <dd>
-In case all classes in a project start with a common prefix, all
-classes will be put under the same header in the alphabetical index.
-The \c IGNORE_PREFIX tag can be use to specify a prefix that should be ignored
-while generating the index headers.
+In case all classes in a project start with a common prefix, all classes will
+be put under the same header in the alphabetical index.
+The \c IGNORE_PREFIX tag can be used to specify a prefix
+(or a list of prefixes) that should be ignored while generating the index
+headers.
</dl>
diff --git a/doc/install.doc b/doc/install.doc
index 9ee3665..6617900 100644
--- a/doc/install.doc
+++ b/doc/install.doc
@@ -103,8 +103,6 @@ tools should be installed.
the Graph visualization toolkit version 1.5</a><br>
Needed for the include dependency graphs, the graphical inheritance graphs,
and the collaboration graphs.<br>
- <b>Note:</b> For windows you will have to set the <code>DOTFONTPATH</code> environment
- variable to include the current directory (e.g. <code>DOTFONTPATH=.</code>)
<li><a href="http://msdn.microsoft.com/workshop/author/htmlhelp">
the HTML help workshop</a> (for Windows only)<br>
Needed for compiling compressed HTML output (a.k.a. the new Windows help format).