summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authoralbert-github <albert.tests@gmail.com>2019-06-26 17:58:50 (GMT)
committeralbert-github <albert.tests@gmail.com>2019-06-26 17:58:50 (GMT)
commit54cb30bf6c3a4ba1b2830970f669559ce23ae7be (patch)
tree5fc6ee20d0254631fd87f7664cdce5da1000580c
parent1fae484ad6abf53cfb3364df173db3522c3e0e29 (diff)
downloadDoxygen-54cb30bf6c3a4ba1b2830970f669559ce23ae7be.zip
Doxygen-54cb30bf6c3a4ba1b2830970f669559ce23ae7be.tar.gz
Doxygen-54cb30bf6c3a4ba1b2830970f669559ce23ae7be.tar.bz2
Update documentation for msc
Due to the built in mscgen code the documentation needed some updates.
-rw-r--r--doc/commands.doc5
1 files changed, 2 insertions, 3 deletions
diff --git a/doc/commands.doc b/doc/commands.doc
index 8e91b9c..ca7786c 100644
--- a/doc/commands.doc
+++ b/doc/commands.doc
@@ -2784,8 +2784,7 @@ See also the \ref emojisup "emoji support page" for details.
\note The text fragment should only include the part of the message
sequence chart that is
within the <code>msc {...}</code> block.
- \note You need to install the <code>mscgen</code> tool, if you want to use this
- command.
+ \note mscgen is now built in into doxygen
Here is an example of the use of the \c \\msc command.
\code
@@ -2923,7 +2922,7 @@ class Receiver
The first argument specifies the file name of the image.
doxygen will look for files in the paths (or files) that you specified
after the \ref cfg_mscfile_dirs "MSCFILE_DIRS" tag.
- If the msc file is found it will be used as an input file to the mscgen tool.
+ If the msc file is found it will be used as an input file to the built in mscgen tool.
The resulting image will be put into the correct output directory.
If the msc file name contains spaces you'll have to put quotes ("...") around it.