summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorDimitri van Heesch <dimitri@stack.nl>2013-10-06 19:28:00 (GMT)
committerDimitri van Heesch <dimitri@stack.nl>2013-10-06 21:39:40 (GMT)
commit4fc5b2b154331fbf35800935889f1d0372334f0a (patch)
treea87e075516435e0d855a4af6aecb356a517c4b33 /doc
parent983507e0a65e5c2d51209740a89311e122e4f389 (diff)
downloadDoxygen-4fc5b2b154331fbf35800935889f1d0372334f0a.zip
Doxygen-4fc5b2b154331fbf35800935889f1d0372334f0a.tar.gz
Doxygen-4fc5b2b154331fbf35800935889f1d0372334f0a.tar.bz2
Bug 707713 - Add support for dia diagrams
Diffstat (limited to 'doc')
-rw-r--r--doc/commands.doc19
-rw-r--r--doc/config.doc17
2 files changed, 36 insertions, 0 deletions
diff --git a/doc/commands.doc b/doc/commands.doc
index 912e9ec..b53c9d7 100644
--- a/doc/commands.doc
+++ b/doc/commands.doc
@@ -65,6 +65,7 @@ documentation:
\refitem cmddefgroup \\defgroup
\refitem cmddeprecated \\deprecated
\refitem cmddetails \\details
+\refitem cmddiafile \\diafile
\refitem cmddir \\dir
\refitem cmddocbookonly \\docbookonly
\refitem cmddontinclude \\dontinclude
@@ -2518,6 +2519,24 @@ class Receiver
\sa section \ref cmdmsc "\\msc".
<hr>
+\section cmddiafile \\diafile <file> ["caption"]
+
+ \addindex \\diafile
+ Inserts an image made in dia from \<file\> into the documentation.
+
+ 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_diafile_dirs "DIAFILE_DIRS" tag.
+ If the dia file is found it will be used as an input file dia.
+ The resulting image will be put into the correct output directory.
+ If the dia file name contains spaces you'll have to put quotes ("...") around it.
+
+ The second argument is optional and can be used to specify the caption
+ that is displayed below the image. This argument has to be specified
+ between quotes even if it does not contain any spaces. The quotes are
+ stripped before the caption is displayed.
+
+<hr>
\section cmde \\e <word>
\addindex \\e
diff --git a/doc/config.doc b/doc/config.doc
index ec19732..1637275 100644
--- a/doc/config.doc
+++ b/doc/config.doc
@@ -88,6 +88,8 @@ followed by the descriptions of the tags grouped by category.
\refitem cfg_compact_rtf COMPACT_RTF
\refitem cfg_cpp_cli_support CPP_CLI_SUPPORT
\refitem cfg_create_subdirs CREATE_SUBDIRS
+\refitem cfg_dia_path DIA_PATH
+\refitem cfg_diafile_dirs DIAFILE_DIRS
\refitem cfg_directory_graph DIRECTORY_GRAPH
\refitem cfg_disable_index DISABLE_INDEX
\refitem cfg_distribute_group_doc DISTRIBUTE_GROUP_DOC
@@ -3306,6 +3308,14 @@ The default value is: <code>YES</code>.
specify the directory where the \c mscgen tool resides. If left empty the tool is assumed to
be found in the default search path.
+ \anchor cfg_dia_path
+<dt>\c DIA_PATH <dd>
+ \addindex DIA_PATH
+ You can include diagrams drawn in dia using the \ref cmddiafile "\\diafile" command.
+ Doxygen will run dia to produce the appropriate image and insert it in the documentation.
+ The <code>DIA_PATH</code> tag allows you to specify the directory where the \c dia
+ binary resides. If left empty the tool is assumed to be found in the default search path.
+
\anchor cfg_hide_undoc_relations
<dt>\c HIDE_UNDOC_RELATIONS <dd>
\addindex HIDE_UNDOC_RELATIONS
@@ -3592,6 +3602,13 @@ This tag requires that the tag \ref cfg_have_dot "HAVE_DOT" is set to \c YES.
contain msc files that are included in the documentation (see the
\ref cmdmscfile "\\mscfile" command).
+ \anchor cfg_diafile_dirs
+<dt>\c DIAFILE_DIRS <dd>
+ \addindex DIAFILE_DIRS
+ The \c DIAFILE_DIRS tag can be used to specify one or more directories that
+ contain dia files that are included in the documentation (see the
+ \ref cmddiafile "\\diafile" command).
+
\anchor cfg_dot_graph_max_nodes
<dt>\c DOT_GRAPH_MAX_NODES <dd>
\addindex DOT_GRAPH_MAX_NODES