Merge branch 'dia' (8320e8ce) · Commits · Elphel / doxverilog

doc/commands.doc

+19 −0

Original line number	Original line	Diff line number	Diff line
	@@ -65,6 +65,7 @@ documentation:
	\refitem cmddefgroup \\defgroup		\refitem cmddefgroup \\defgroup
	\refitem cmddeprecated \\deprecated		\refitem cmddeprecated \\deprecated
	\refitem cmddetails \\details		\refitem cmddetails \\details
			\refitem cmddiafile \\diafile
	\refitem cmddir \\dir		\refitem cmddir \\dir
	\refitem cmddocbookonly \\docbookonly		\refitem cmddocbookonly \\docbookonly
	\refitem cmddontinclude \\dontinclude		\refitem cmddontinclude \\dontinclude
	@@ -2517,6 +2518,24 @@ class Receiver

	\sa section \ref cmdmsc "\\msc".		\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>		<hr>
	\section cmde \\e <word>		\section cmde \\e <word>

doc/config.doc

+17 −0

Original line number	Original line	Diff line number	Diff line
	@@ -88,6 +88,8 @@ followed by the descriptions of the tags grouped by category.
	\refitem cfg_compact_rtf COMPACT_RTF		\refitem cfg_compact_rtf COMPACT_RTF
	\refitem cfg_cpp_cli_support CPP_CLI_SUPPORT		\refitem cfg_cpp_cli_support CPP_CLI_SUPPORT
	\refitem cfg_create_subdirs CREATE_SUBDIRS		\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_directory_graph DIRECTORY_GRAPH
	\refitem cfg_disable_index DISABLE_INDEX		\refitem cfg_disable_index DISABLE_INDEX
	\refitem cfg_distribute_group_doc DISTRIBUTE_GROUP_DOC		\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		specify the directory where the \c mscgen tool resides. If left empty the tool is assumed to
	be found in the default search path.		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		\anchor cfg_hide_undoc_relations
	<dt>\c HIDE_UNDOC_RELATIONS <dd>		<dt>\c HIDE_UNDOC_RELATIONS <dd>
	\addindex HIDE_UNDOC_RELATIONS		\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		contain msc files that are included in the documentation (see the
	\ref cmdmscfile "\\mscfile" command).		\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		\anchor cfg_dot_graph_max_nodes
	<dt>\c DOT_GRAPH_MAX_NODES <dd>		<dt>\c DOT_GRAPH_MAX_NODES <dd>
	\addindex DOT_GRAPH_MAX_NODES		\addindex DOT_GRAPH_MAX_NODES

src/cmdmapper.cpp

+1 −0

Original line number	Original line	Diff line number	Diff line
	@@ -134,6 +134,7 @@ CommandMap cmdMap[] =
	{ "endinternal", CMD_ENDINTERNAL },		{ "endinternal", CMD_ENDINTERNAL },
	{ "parblock", CMD_PARBLOCK },		{ "parblock", CMD_PARBLOCK },
	{ "endparblock", CMD_ENDPARBLOCK },		{ "endparblock", CMD_ENDPARBLOCK },
			{ "diafile", CMD_DIAFILE },
	{ 0, 0 },		{ 0, 0 },
	};		};

src/cmdmapper.h

+2 −1

Original line number	Original line	Diff line number	Diff line
	@@ -123,7 +123,8 @@ enum CommandType
	CMD_ENDDBONLY = 93,		CMD_ENDDBONLY = 93,
	CMD_ENDINTERNAL = 94,		CMD_ENDINTERNAL = 94,
	CMD_PARBLOCK = 95,		CMD_PARBLOCK = 95,
	CMD_ENDPARBLOCK = 96		CMD_ENDPARBLOCK = 96,
			CMD_DIAFILE = 97
	};		};

	enum HtmlTagType		enum HtmlTagType

src/compound.xsd

+5 −2

Original line number	Original line	Diff line number	Diff line
	@@ -386,6 +386,7 @@
	<xsd:element name="rtfonly" type="xsd:string" />		<xsd:element name="rtfonly" type="xsd:string" />
	<xsd:element name="latexonly" type="xsd:string" />		<xsd:element name="latexonly" type="xsd:string" />
	<xsd:element name="dot" type="xsd:string" />		<xsd:element name="dot" type="xsd:string" />
			<xsd:element name="msc" type="xsd:string" />
	<xsd:element name="anchor" type="docAnchorType" />		<xsd:element name="anchor" type="docAnchorType" />
	<xsd:element name="formula" type="docFormulaType" />		<xsd:element name="formula" type="docFormulaType" />
	<xsd:element name="ref" type="docRefTextType" />		<xsd:element name="ref" type="docRefTextType" />
	@@ -501,7 +502,9 @@
	<xsd:element name="table" type="docTableType" />		<xsd:element name="table" type="docTableType" />
	<xsd:element name="heading" type="docHeadingType" />		<xsd:element name="heading" type="docHeadingType" />
	<xsd:element name="image" type="docImageType" />		<xsd:element name="image" type="docImageType" />
	<xsd:element name="dotfile" type="docDotFileType" />		<xsd:element name="dotfile" type="docFileType" />
			<xsd:element name="mscfile" type="docFileType" />
			<xsd:element name="diafile" type="docFileType" />
	<xsd:element name="toclist" type="docTocListType" />		<xsd:element name="toclist" type="docTocListType" />
	<xsd:element name="language" type="docLanguageType" />		<xsd:element name="language" type="docLanguageType" />
	<xsd:element name="parameterlist" type="docParamListType" />		<xsd:element name="parameterlist" type="docParamListType" />
	@@ -628,7 +631,7 @@
	<xsd:attribute name="height" type="xsd:string" />		<xsd:attribute name="height" type="xsd:string" />
	</xsd:complexType>		</xsd:complexType>

	<xsd:complexType name="docDotFileType" mixed="true">		<xsd:complexType name="docFileType" mixed="true">
	<xsd:group ref="docTitleCmdGroup" minOccurs="0" maxOccurs="unbounded" />		<xsd:group ref="docTitleCmdGroup" minOccurs="0" maxOccurs="unbounded" />
	<xsd:attribute name="name" type="xsd:string" />		<xsd:attribute name="name" type="xsd:string" />
	</xsd:complexType>		</xsd:complexType>

Admin message