From 773d0aafb4f603b6924d86a60a2828bd44a16756 Mon Sep 17 00:00:00 2001
From: albert-github <albert.tests@gmail.com>
Date: Mon, 23 Nov 2020 18:48:35 +0100
Subject: 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.
---
 doc/commands.doc       | 9 +++++++++
 src/config.xml         | 7 +++++--
 src/docbookvisitor.cpp | 4 +++-
 3 files changed, 17 insertions(+), 3 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/src/config.xml b/src/config.xml
index 0ec4219..9077f04 100644
--- a/src/config.xml
+++ b/src/config.xml
@@ -3690,11 +3690,14 @@ add type and arguments for attributes and methods in the UML graphs.
 ]]>
       </docs>
     </option>
-    <option type='bool' id='DOT_CLEANUP' defval='1' depends='HAVE_DOT'>
+    <option type='bool' id='DOT_CLEANUP' defval='1'>
       <docs>
 <![CDATA[
 If the \c DOT_CLEANUP tag is set to \c YES, doxygen will
-remove the intermediate dot files that are used to generate the various graphs.
+remove the intermediate files that are used to generate the various graphs.
+ <br>Note:
+This setting is not only used for dot files but also for msc and plantuml
+temporary files.
 ]]>
       </docs>
     </option>
diff --git a/src/docbookvisitor.cpp b/src/docbookvisitor.cpp
index bf6c827..d444b7b 100644
--- a/src/docbookvisitor.cpp
+++ b/src/docbookvisitor.cpp
@@ -356,12 +356,13 @@ DB_VIS_C
         QFile file(baseName+".dot");
         if (!file.open(IO_WriteOnly))
         {
-          err("Could not open file %s.msc for writing\n",baseName.data());
+          err("Could not open file %s.dot for writing\n",baseName.data());
         }
         file.writeBlock( stext, stext.length() );
         file.close();
         writeDotFile(baseName, s);
         m_t << "</para>" << endl;
+        if (Config_getBool(DOT_CLEANUP)) file.remove();
       }
       break;
     case DocVerbatim::Msc:
@@ -388,6 +389,7 @@ DB_VIS_C
         file.close();
         writeMscFile(baseName,s);
         m_t << "</para>" << endl;
+        if (Config_getBool(DOT_CLEANUP)) file.remove();
       }
       break;
     case DocVerbatim::PlantUML:
-- 
cgit v0.12