summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
Diffstat (limited to 'doc')
-rw-r--r--doc/commands.doc9
-rw-r--r--doc/starting.doc8
2 files changed, 15 insertions, 2 deletions
diff --git a/doc/commands.doc b/doc/commands.doc
index 6c1f340..b58daed 100644
--- a/doc/commands.doc
+++ b/doc/commands.doc
@@ -2800,6 +2800,10 @@ only copy the detailed documentation, not the brief description.
The nodes of a graph can be made clickable by using the URL attribute.
By using the command \ref cmdref "\\ref" inside the URL value you can conveniently
link to an item inside doxygen. Here is an example:
+
+ \note doxygen creates a temporary file that is automatically removed unless
+ the \ref cfg_dot_cleanup "DOT_CLEANUP" tag is set to `NO`.
+
\code
/*! class B */
class B {};
@@ -2863,6 +2867,8 @@ See also the \ref emojisup "emoji support page" for details.
within the <code>msc {...}</code> block (this is different from
\ref cmdmscfile "\\mscfile").
\note mscgen is now built in into doxygen
+ \note doxygen creates a temporary file that is automatically removed unless
+ the \ref cfg_dot_cleanup "DOT_CLEANUP" tag is set to `NO`.
Here is an example of the use of the \c \\msc command.
\code
@@ -2933,6 +2939,9 @@ class Receiver
\ref image_sizeindicator "Size indication" with the
\ref cmdimage "\\image" command.
+ \note doxygen creates a temporary file that is automatically removed unless
+ the \ref cfg_dot_cleanup "DOT_CLEANUP" tag is set to `NO`.
+
Here is an example of the use of the \c \\startuml command.
\code
/** Sender class. Can be used to send a command to the server.
diff --git a/doc/starting.doc b/doc/starting.doc
index 4c9823c..2f4f419 100644
--- a/doc/starting.doc
+++ b/doc/starting.doc
@@ -103,6 +103,7 @@ To omit all \c test directories from a source tree for instance, one could use:
\verbatim EXCLUDE_PATTERNS = */test/*
\endverbatim
+\anchor default_file_extension_mapping
Doxygen looks at the file's extension to determine how to parse a file,
using the following table:
@@ -130,8 +131,11 @@ Extension | Language | Extension | Language | Extension | Language
.mm |C / C++ | | | | |
.txt |C / C++ | | | | |
-Any other extension is not parsed unless it is added to
-\ref cfg_file_patterns "FILE_PATTERNS" and the appropriate
+Please note that the above list might contain more items than that by default set
+in the \ref cfg_file_patterns "FILE_PATTERNS".
+
+Any extension that is not parsed can be set by adding it to
+\ref cfg_file_patterns "FILE_PATTERNS" and when the appropriate
\ref cfg_extension_mapping "EXTENSION_MAPPING" is set.
\anchor extract_all