summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authordimitri <dimitri@afe2bf4a-e733-0410-8a33-86f594647bc7>2007-03-15 10:14:23 (GMT)
committerdimitri <dimitri@afe2bf4a-e733-0410-8a33-86f594647bc7>2007-03-15 10:14:23 (GMT)
commit97a3911e2682bfebeebbb8999c9e3844c414c3e0 (patch)
tree5300b179faf00eea740dda6ee3be5343c70b1c79 /doc
parentf7f03d9491454ddc9b855b8637d482df6bd622c2 (diff)
downloadDoxygen-97a3911e2682bfebeebbb8999c9e3844c414c3e0.zip
Doxygen-97a3911e2682bfebeebbb8999c9e3844c414c3e0.tar.gz
Doxygen-97a3911e2682bfebeebbb8999c9e3844c414c3e0.tar.bz2
Release-1.5.1-20070315
Diffstat (limited to 'doc')
-rw-r--r--doc/commands.doc55
-rw-r--r--doc/config.doc10
-rw-r--r--doc/faq.doc39
-rw-r--r--doc/language.doc4
-rw-r--r--doc/translator_report.txt2
5 files changed, 74 insertions, 36 deletions
diff --git a/doc/commands.doc b/doc/commands.doc
index 1b03dbb..298f492 100644
--- a/doc/commands.doc
+++ b/doc/commands.doc
@@ -74,6 +74,7 @@ documentation:
\refitem cmdendlatexonly \\endlatexonly
\refitem cmdendlink \\endlink
\refitem cmdendmanonly \\endmanonly
+\refitem cmdendmsc \\endmsc
\refitem cmdendverbatim \\endverbatim
\refitem cmdendxmlonly \\endxmlonly
\refitem cmdenum \\enum
@@ -102,6 +103,7 @@ documentation:
\refitem cmdlink \\link
\refitem cmdmainpage \\mainpage
\refitem cmdmanonly \\manonly
+\refitem cmdmsc \\msc
\refitem cmdn \\n
\refitem cmdname \\name
\refitem cmdnamespace \\namespace
@@ -1779,6 +1781,53 @@ class C {};
\endcode
<hr>
+\section cmdmsc \\msc
+
+ \addindex \\msc
+ Starts a text fragment which should contain a valid description of a
+ message sequence chart. See http://www.mcternan.me.uk/mscgen/ for examples.
+ The text fragment ends with \ref cmdendmsc "\\endmsc".
+ \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.
+
+Here is an example of the use of the \\msc command.
+\code
+/** Sender class. Can be used to send a command to the server.
+ * The receiver will acknowlegde the command by calling Ack().
+ * \msc
+ * Sender,Receiver;
+ * Sender->Receiver [label="Command()", URL="\ref Receiver::Command()"];
+ * Sender<-Receiver [label="Ack()", URL="\ref Ack()", ID="1"];
+ * \endmsc
+ */
+class Sender
+{
+ public:
+ /** Acknowledgement from server */
+ void Ack(bool ok);
+};
+
+/** Receiver class. Can be used to receive and execute commands.
+ * After execution of a command, the receiver will send an acknowledgement
+ * \msc
+ * Receiver,Sender;
+ * Receiver<-Sender [label="Command()", URL="\ref Command()"];
+ * Receiver->Sender [label="Ack()", URL="\ref Sender::Ack()", ID="1"];
+ * \endmsc
+ */
+class Receiver
+{
+ public:
+ /** Executable a command on the server */
+ void Command(int commandId);
+};
+
+\endcode
+
+<hr>
\section cmddotfile \\dotfile <file> ["caption"]
\addindex \\dotfile
@@ -1845,6 +1894,12 @@ class C {};
Ends a blocks that was started with \ref cmddot "\\dot".
<hr>
+\section cmdendmsc \\endmsc
+
+ \addindex \\endmsc
+ Ends a blocks that was started with \ref cmdmsc "\\msc".
+
+<hr>
\section cmdendhtmlonly \\endhtmlonly
\addindex \\endhtmlonly
diff --git a/doc/config.doc b/doc/config.doc
index e1c9481..8801aa1 100644
--- a/doc/config.doc
+++ b/doc/config.doc
@@ -163,6 +163,7 @@ followed by the descriptions of the tags grouped by category.
\refitem cfg_man_links MAN_LINKS
\refitem cfg_man_output MAN_OUTPUT
\refitem cfg_max_initializer_lines MAX_INITIALIZER_LINES
+\refitem cfg_mscgen_path MSCGEN_PATH
\refitem cfg_multiline_cpp_is_brief MULTILINE_CPP_IS_BRIEF
\refitem cfg_optimize_output_for_c OPTIMIZE_OUTPUT_FOR_C
\refitem cfg_optimize_output_java OPTIMIZE_OUTPUT_JAVA
@@ -1635,6 +1636,15 @@ TAGFILES = file1=loc1 "file2 = loc2" ... </pre>
This is only a fallback. It is recommended to install and use dot,
since it yields more powerful graphs.
+\anchor cfg_mscgen_path
+<dt>\c MSCGEN_PATH <dd>
+ \addindex MSCGEN_PATH
+ You can define message sequence charts within doxygen comments using the \ref cmdmsc "\\msc"
+ command. Doxygen will then run the <a href="http://www.mcternan.me.uk/mscgen/">msgen tool</a>) to
+ produce the chart and insert it in the documentation. The <code>MSCGEN_PATH</code> tag allows you to
+ specify the directory where the mscgen tool resides. If left empty the tool is assumed to
+ be found in the default search path.
+
\anchor cfg_have_dot
<dt>\c HAVE_DOT <dd>
\addindex HAVE_DOT
diff --git a/doc/faq.doc b/doc/faq.doc
index 8ade978..51f3c24 100644
--- a/doc/faq.doc
+++ b/doc/faq.doc
@@ -237,39 +237,12 @@ various buffers and then run "texconfig init".
<li><b>Why are dependencies via STL classes not shown in the dot graphs?</b>
-Doxygen is unware of the STL classes, so it does not know that class A relates
-to class B in the following example
-
-\code
-#include <vector>
-
-using namespace std;
-
-class B {};
-
-class A
-{
- public:
- vector<B> m_bvec;
-};
-\endcode
-
-To overcome this problem you could provide the definition of the vector
-class to doxygen (by including the file that defines it at the INPUT tag
-in the config file). Since STL header files are often messy, a
-(possibly) better approach is to include a dummy definition of a vector
-class to the input. Here is an example of a dummy STL file for the vector
-class:
-
-\code
-namespace std {
- /*! STL vector class */
- template<class T> class vector { public: T element; };
-}
-\endcode
-
-I'm still looking for someone who can provide me with definitions
-for all (relevant) STL classes.
+Doxygen is unware of the STL classes, unless the option BUILTIN_STL_SUPPORT is
+turned on.
+
+<li><b>I have problems getting the search engine to work with PHP5 and/or windows</b>
+
+Please read <a href="searchengine.html">this</a> for hints on where to look.
<li><b>Can I configure doxygen from the command line?</b>
diff --git a/doc/language.doc b/doc/language.doc
index e2f9114..c304eec 100644
--- a/doc/language.doc
+++ b/doc/language.doc
@@ -1,7 +1,7 @@
/******************************************************************************
* Do not edit this file. It was generated by the translator.py script.
*
- * Copyright (C) 1997-2007 by Dimitri van Heesch.
+ * Copyright (C) 1997-2006 by Dimitri van Heesch.
*
* Permission to use, copy, modify, and distribute this software and its
* documentation under the terms of the GNU General Public License is hereby
@@ -23,7 +23,7 @@ text fragments, generated by doxygen, can be produced in languages other
than English (the default). The output language is chosen through the
configuration file (with default name and known as Doxyfile).
-Currently (version 1.5.1), 33 languages
+Currently (version 1.5.1-20070219), 33 languages
are supported (sorted alphabetically):
Afrikaans, Arabic, Brazilian Portuguese, Catalan, Chinese, Chinese
Traditional, Croatian, Czech, Danish, Dutch, English, Finnish, French,
diff --git a/doc/translator_report.txt b/doc/translator_report.txt
index 1f65482..2b351ed 100644
--- a/doc/translator_report.txt
+++ b/doc/translator_report.txt
@@ -1,4 +1,4 @@
-(1.5.1)
+(1.5.1-20070219)
Doxygen supports the following 33 languages (sorted alphabetically):