summaryrefslogtreecommitdiffstats
path: root/doc/commands.doc
diff options
context:
space:
mode:
authoralbert-github <albert.tests@gmail.com>2020-11-23 17:48:35 (GMT)
committeralbert-github <albert.tests@gmail.com>2020-11-23 17:48:35 (GMT)
commit773d0aafb4f603b6924d86a60a2828bd44a16756 (patch)
tree72ed16d9cd63aab25a8bf43695e841ea11f0c93c /doc/commands.doc
parent4e75d77f60bd173019247177686376ce36ace90b (diff)
downloadDoxygen-773d0aafb4f603b6924d86a60a2828bd44a16756.zip
Doxygen-773d0aafb4f603b6924d86a60a2828bd44a16756.tar.gz
Doxygen-773d0aafb4f603b6924d86a60a2828bd44a16756.tar.bz2
Making the use of DOT_CLEANUP more transparent
- The setting `DOT_CLEANUP` is not only used for `dot` files but also for temporary `msc` and `plantuml` files, though this was not clear from the documentation. - For the docbook output format the removal of the `dot` and `msc` files was not don like in the output formats html / LatTeX / rtf.
Diffstat (limited to 'doc/commands.doc')
-rw-r--r--doc/commands.doc9
1 files changed, 9 insertions, 0 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.