summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
Diffstat (limited to 'doc')
-rw-r--r--doc/commands.doc7
-rw-r--r--doc/config.doc9
2 files changed, 16 insertions, 0 deletions
diff --git a/doc/commands.doc b/doc/commands.doc
index 26e58ca..9544ad9 100644
--- a/doc/commands.doc
+++ b/doc/commands.doc
@@ -131,6 +131,7 @@ documentation:
\refitem cmdretval \\retval
\refitem cmdsa \\sa
\refitem cmdsection \\section
+\refitem cmdsee \\see
\refitem cmdshowinitializer \\showinitializer
\refitem cmdsince \\since
\refitem cmdskip \\skip
@@ -1151,6 +1152,12 @@ void memcpy(void *dest, const void *src, size_t n);
to objects.
<hr>
+\section cmdsee \see { references }
+
+ \addindex \\see
+ Equivalent to \ref cmdsa "\\sa". Introduced for compatibility with Javadoc.
+
+<hr>
\section cmdsince \since { text }
\addindex \\since
diff --git a/doc/config.doc b/doc/config.doc
index e1e9472..8885525 100644
--- a/doc/config.doc
+++ b/doc/config.doc
@@ -205,6 +205,7 @@ followed by the descriptions of the tags grouped by category.
\refitem cfg_warn_if_doc_error WARN_IF_DOC_ERROR
\refitem cfg_warn_if_undocumented WARN_IF_UNDOCUMENTED
\refitem cfg_warn_logfile WARN_LOGFILE
+\refitem cfg_warn_no_paramdoc WARN_NO_PARAMDOC
\refitem cfg_warnings WARNINGS
\refitem cfg_xml_dtd XML_DTD
\refitem cfg_xml_output XML_OUTPUT
@@ -673,6 +674,14 @@ function's detailed documentation block.
parameters in a documented function, or documenting parameters that
don't exist or using markup commands wrongly.
+\anchor cfg_warn_no_paramdoc
+<dt>\c WARN_NO_PARAMDOC
+This \c WARN_NO_PARAMDOC option can be abled to get warnings for
+functions that are documented, but have no documentation for their parameters
+or return value. If set to \c NO (the default) doxygen will only warn about
+wrong or incomplete parameter documentation, but not about the absence of
+documentation.
+
\anchor cfg_warn_format
<dt>\c WARN_FORMAT <dd>
\addindex WARN_FORMAT