summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorDimitri van Heesch <doxygen@gmail.com>2020-11-24 21:15:22 (GMT)
committerGitHub <noreply@github.com>2020-11-24 21:15:22 (GMT)
commit526a901c2ea1315727f8c60e48b799db39803fcd (patch)
tree86415af97524959c918da673f905cf8e4840c48f /doc
parent55ca9c847c2a183e1382a2b7f3f7bcfe7cdc852f (diff)
parent773d0aafb4f603b6924d86a60a2828bd44a16756 (diff)
downloadDoxygen-526a901c2ea1315727f8c60e48b799db39803fcd.zip
Doxygen-526a901c2ea1315727f8c60e48b799db39803fcd.tar.gz
Doxygen-526a901c2ea1315727f8c60e48b799db39803fcd.tar.bz2
Merge pull request #8198 from albert-github/feature/bug_dot_cleanup
Making the use of DOT_CLEANUP more transparent
Diffstat (limited to '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.