summaryrefslogtreecommitdiff
path: root/doc/trouble.doc
diff options
context:
space:
mode:
authorDongHun Kwak <dh0128.kwak@samsung.com>2021-10-15 10:46:26 +0900
committerDongHun Kwak <dh0128.kwak@samsung.com>2021-10-15 10:46:26 +0900
commitb7b8bd24feb1363d7d84d030b9ea688fe2f149de (patch)
tree83a30b06a24a934bb4120199cd0c180ece6fc1ed /doc/trouble.doc
parent046aece77e373b5280b56bf871fa6e974d06e85d (diff)
downloaddoxygen-b7b8bd24feb1363d7d84d030b9ea688fe2f149de.tar.gz
doxygen-b7b8bd24feb1363d7d84d030b9ea688fe2f149de.tar.bz2
doxygen-b7b8bd24feb1363d7d84d030b9ea688fe2f149de.zip
Imported Upstream version 1.8.4upstream/1.8.4
Diffstat (limited to 'doc/trouble.doc')
-rw-r--r--doc/trouble.doc20
1 files changed, 11 insertions, 9 deletions
diff --git a/doc/trouble.doc b/doc/trouble.doc
index c795b0f..3a89922 100644
--- a/doc/trouble.doc
+++ b/doc/trouble.doc
@@ -2,7 +2,7 @@
*
*
*
- * Copyright (C) 1997-2012 by Dimitri van Heesch.
+ * Copyright (C) 1997-2013 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
@@ -16,7 +16,7 @@
*/
/*! \page trouble Troubleshooting
-<h2>Known problems:</h2>
+\section knowproblems Known Problems
<ul>
<li>If you have problems building doxygen from sources, please
read \ref unix_problems "this section" first.
@@ -31,7 +31,7 @@
or unions with the same name in your code. It should not crash however,
rather it should ignore all of the classes with the same name except one.
<li>Some commands do not work inside the arguments of other commands.
- Inside a HTML link (i.e. \<a href="..."\>...\<a\>) for instance
+ Inside a HTML link (i.e. \<a&nbsp;href="..."\>...\<a\>) for instance
other commands (including other HTML commands) do not work!
The sectioning commands are an important exception.
<li>Redundant braces can confuse doxygen in some cases.
@@ -51,7 +51,7 @@
\endverbatim
then doxygen will remove the braces and correctly parse the result.
<li>Not all names in code fragments that are included in the documentation
- are replaced by links (for instance when using \c SOURCE_BROWSER = \c YES)
+ are replaced by links (for instance when using \ref cfg_source_browser "SOURCE_BROWSER" = `YES`)
and links to overloaded members may point to the wrong member.
This also holds for the "Referenced by" list that is generated for
each function.
@@ -62,7 +62,8 @@
documentation, because of possible ambiguities or lack of
information about the context in which the code fragment is found.
<li>It is not possible to insert a non-member function f in a class A
- using the \\relates or \\relatesalso command, if class A already
+ using the \ref cmdrelates "\\relates" or \ref cmdrelatesalso "\\relatesalso"
+ command, if class A already
has a member with name f and the same argument list.
<li>There is only very limited support for member specialization at the
moment. It only works if there is a specialized template class as
@@ -76,15 +77,14 @@
</ul>
-<h2>How to help</h2>
+\section howtohelp How to Help
The development of Doxygen highly depends on your input!
If you are trying Doxygen let me know what you think of it (do you
miss certain features?). Even if you decide not to use it, please let me
know why.
-\anchor bug_reports
-<h2>How to report a bug</h2>
+\section bug_reports How to report a bug
Bugs are tracked in GNOME's <a href="http://bugzilla.gnome.org">bugzilla</a> database.
Before submitting a
@@ -135,8 +135,10 @@ one file please tar or zip everything, so I only have to save and download
one file.
\htmlonly
-Return to the <a href="index.html">index</a>.
+Go to the <a href="features.html">next</a> section or return to the
+ <a href="index.html">index</a>.
\endhtmlonly
+
*/