Merge branch 'master' of github.com:doxygen/doxygen (db905733) · Commits · Elphel / doxverilog

doc/commands.doc

+21 −1

Original line number	Original line	Diff line number	Diff line
	@@ -230,7 +230,7 @@ Structural indicators
	any of the commands.		any of the commands.

	The title is optional, so this command can also be used to add a number of		The title is optional, so this command can also be used to add a number of
	entities to an existing group using \@{ and \@} like this:		entities to an existing group using \c \@{ and \c \@} like this:

	\verbatim		\verbatim
	/*! \addtogroup mygrp		/*! \addtogroup mygrp
	@@ -1740,6 +1740,26 @@ void setPosition(double x,double y,double z,double t)
	Note the use of escaped quotes for the second and third argument of the		Note the use of escaped quotes for the second and third argument of the
	\c \\xrefitem command.		\c \\xrefitem command.

			In case parameter "(heading)" is the empty string no heading is generated. This can be useful
			when used in combination with the \ref cmdpage "\\page" command e.g.
			\verbatim
			/** @page my_errors My Errors
			* @brief Errors page
			*
			* Errors page contents.
			*/

			/** \error ERROR 101: in case a file can not be opened.
			Check about file system read/write access. */
			#define MY_ERR_CANNOT_OPEN_FILE 101

			/** \error ERROR 102: in case a file can not be closed.
			Check about file system read/write access. */
			#define MY_ERR_CANNOT_CLOSE_FILE 102
			\endverbatim
			with \c \\error defined as
			\verbatim ALIASES += "error=\xrefitem my_errors \"\" \"\"" \endverbatim

	<hr>		<hr>

	\htmlonly <center> \endhtmlonly		\htmlonly <center> \endhtmlonly

+0 −10

Original line number	Original line	Diff line number	Diff line
	@@ -137,22 +137,12 @@ input used in their production; they are not affected by this license.

	Doxygen supports a number of \ref output "output formats" where HTML is the		Doxygen supports a number of \ref output "output formats" where HTML is the
	most popular one. I've gathered		most popular one. I've gathered
	\htmlonly
	<a href="http://www.doxygen.org/results.html">some nice examples</a>		<a href="http://www.doxygen.org/results.html">some nice examples</a>
	\endhtmlonly
	\latexonly
	some nice examples (see {\tt http://www.doxygen.org/results.html})
	\endlatexonly
	of real-life projects using doxygen.		of real-life projects using doxygen.

	These are part of a larger		These are part of a larger
	\htmlonly
	<a href="http://www.doxygen.org/projects.html">list of projects</a>		<a href="http://www.doxygen.org/projects.html">list of projects</a>
	that use doxygen.		that use doxygen.
	\endhtmlonly
	\latexonly
	list of projects that use doxygen (see {\tt http://www.doxygen.org/projects.html}).
	\endlatexonly
	If you know other projects, let <a href="mailto:dimitri@stack.nl?subject=New%20project%20using%20Doxygen">me</a>		If you know other projects, let <a href="mailto:dimitri@stack.nl?subject=New%20project%20using%20Doxygen">me</a>
	know and I'll add them.		know and I'll add them.

+3 −1

Original line number	Original line	Diff line number	Diff line
	@@ -1160,6 +1160,7 @@ void DocbookDocVisitor::visitPost(DocParamList *)
	void DocbookDocVisitor::visitPre(DocXRefItem *x)		void DocbookDocVisitor::visitPre(DocXRefItem *x)
	{		{
	if (m_hide) return;		if (m_hide) return;
			if (x->title().isEmpty()) return;
	m_t << "<para><link linkend=\"";		m_t << "<para><link linkend=\"";
	m_t << x->file() << "_1" << x->anchor();		m_t << x->file() << "_1" << x->anchor();
	m_t << "\">";		m_t << "\">";
	@@ -1168,9 +1169,10 @@ void DocbookDocVisitor::visitPre(DocXRefItem *x)
	m_t << " ";		m_t << " ";
	}		}

	void DocbookDocVisitor::visitPost(DocXRefItem *)		void DocbookDocVisitor::visitPost(DocXRefItem *x)
	{		{
	if (m_hide) return;		if (m_hide) return;
			if (x->title().isEmpty()) return;
	m_t << "</para>";		m_t << "</para>";
	}		}

+3 −0

Original line number	Original line	Diff line number	Diff line
	@@ -1777,6 +1777,8 @@ void HtmlDocVisitor::visitPost(DocParamList *)
	void HtmlDocVisitor::visitPre(DocXRefItem *x)		void HtmlDocVisitor::visitPre(DocXRefItem *x)
	{		{
	if (m_hide) return;		if (m_hide) return;
			if (x->title().isEmpty()) return;

	forceEndParagraph(x);		forceEndParagraph(x);
	bool anonymousEnum = x->file()=="@";		bool anonymousEnum = x->file()=="@";
	if (!anonymousEnum)		if (!anonymousEnum)
	@@ -1798,6 +1800,7 @@ void HtmlDocVisitor::visitPre(DocXRefItem *x)
	void HtmlDocVisitor::visitPost(DocXRefItem *x)		void HtmlDocVisitor::visitPost(DocXRefItem *x)
	{		{
	if (m_hide) return;		if (m_hide) return;
			if (x->title().isEmpty()) return;
	m_t << "</dd></dl>" << endl;		m_t << "</dd></dl>" << endl;
	forceStartParagraph(x);		forceStartParagraph(x);
	}		}

+3 −1

Original line number	Original line	Diff line number	Diff line
	@@ -1515,6 +1515,7 @@ void LatexDocVisitor::visitPost(DocParamList *pl)
	void LatexDocVisitor::visitPre(DocXRefItem *x)		void LatexDocVisitor::visitPre(DocXRefItem *x)
	{		{
	if (m_hide) return;		if (m_hide) return;
			if (x->title().isEmpty()) return;
	m_t << "\\begin{DoxyRefDesc}{";		m_t << "\\begin{DoxyRefDesc}{";
	filter(x->title());		filter(x->title());
	m_t << "}" << endl;		m_t << "}" << endl;
	@@ -1534,9 +1535,10 @@ void LatexDocVisitor::visitPre(DocXRefItem *x)
	m_t << "}]";		m_t << "}]";
	}		}

	void LatexDocVisitor::visitPost(DocXRefItem *)		void LatexDocVisitor::visitPost(DocXRefItem *x)
	{		{
	if (m_hide) return;		if (m_hide) return;
			if (x->title().isEmpty()) return;
	m_t << "\\end{DoxyRefDesc}" << endl;		m_t << "\\end{DoxyRefDesc}" << endl;
	}		}