Release-1.1.4-20000618 (cb417a1f) · Commits · Elphel / doxverilog

INSTALL

+9 −6

Original line number	Original line	Diff line number	Diff line
	@@ -84,10 +84,13 @@ You will need to install the windows/dos versions of following tools:
	You can download them at: http://sourceware.cygnus.com/cygwin/		You can download them at: http://sourceware.cygnus.com/cygwin/
	Make sure the BISONLIB environment variable points to the		Make sure the BISONLIB environment variable points to the
	location where bison.simple and bison.hairy are located.		location where bison.simple and bison.hairy are located.
	- Qt-1.xx (Qt-2.xx should also work, but I didn't test it for Windows)		- Qt-1.xx (Qt-2.xx does not work without adding some extra code)
	(Hint: only the tools section is required, so you can use the free		Only the tools section is required, so you can use the free
	X-windows version (use Qt-1.44) as well!)		X-windows version (use Qt-1.44) and build a library called qt.lib out of
	You can get it at http://www.troll.no		the sources in src/tools. The library should be put in the lib directory
			of the Qt distribution. You can get Qt-1.44 at http://www.trolltech.com
			Before continuing make sure the QTDIR environment variable points to the
			root of the Qt distribution.
	- Microsoft Visual C++ (I only tested with version 5.0).		- Microsoft Visual C++ (I only tested with version 5.0).
	Use the vcvars32.bat to set the environment variables		Use the vcvars32.bat to set the environment variables
	(if you did not select to do this automatically during installation).		(if you did not select to do this automatically during installation).
	@@ -146,7 +149,7 @@ QT RELATED PROBLEMS:
	- do "cd qt"		- do "cd qt"
	- do "ln -s your-qt-include-dir-here include",		- do "ln -s your-qt-include-dir-here include",
	- do "ln -s your-qt-lib-dir-here lib",		- do "ln -s your-qt-lib-dir-here lib",
	- do "export QTDIR=$PWD" (or "setenv QTDIR $PWD if you have a csh)		- do "export QTDIR=$PWD" (or "setenv QTDIR $PWD if you have a csh-like shell)

	Now install doxygen as described above.		Now install doxygen as described above.

	@@ -252,4 +255,4 @@ The latest version of doxygen can be obtained at

	Enjoy,		Enjoy,

	Dimitri van Heesch (11 June 2000)		Dimitri van Heesch (18 June 2000)

README

+1 −1

Original line number	Original line	Diff line number	Diff line
	@@ -7,4 +7,4 @@ The latest version of doxygen can be obtained at

	Enjoy,		Enjoy,

	Dimitri van Heesch (11 June 2000)		Dimitri van Heesch (18 June 2000)

addon/configgen/config_templ.l

+1 −0

Original line number	Original line	Diff line number	Diff line
	@@ -318,6 +318,7 @@ void configStrToVal()
	static void substEnvVarsInString(QCString &s)		static void substEnvVarsInString(QCString &s)
	{		{
	static QRegExp re("\\$\$[a-z_A-Z0-9]+\$");		static QRegExp re("\\$\$[a-z_A-Z0-9]+\$");
			if (s.isEmpty()) return;
	int p=0;		int p=0;
	int i,l;		int i,l;
	//printf("substEnvVarInString(%s) start\n",s.data());		//printf("substEnvVarInString(%s) start\n",s.data());

addon/configgen/configgen.cpp

+9 −5

Original line number	Original line	Diff line number	Diff line
	@@ -788,29 +788,33 @@ void init()
	"EXTRACT_ALL",		"EXTRACT_ALL",
	"FALSE",		"FALSE",
	"gererate docs for all classes flag",		"gererate docs for all classes flag",
	"If the EXTRACT_ALL tag is set to YES all classes and functions will be \n"		"If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in \n"
	"included in the documentation, even if no documentation was available. \n"		"documentation are documented, even if no documentation was available. \n"
			"Private class members and static file members will be hidden unless \n"
			"the EXTRACT_PRIVATE tag is set to YES \n"
	);		);
	ConfigBool::add( "extractPrivateFlag",		ConfigBool::add( "extractPrivateFlag",
	"EXTRACT_PRIVATE",		"EXTRACT_PRIVATE",
	"FALSE",		"FALSE",
	"generate docs for private members flag",		"generate docs for private members flag",
	"If the EXTRACT_PRIVATE tag is set to YES all private members of a class \n"		"If the EXTRACT_PRIVATE tag is set to YES all private members of a class \n"
	"will be included in the documentation. \n"		"and the static members of a file will be included in the documentation. \n"
	);		);
	ConfigBool::add( "hideMemberFlag",		ConfigBool::add( "hideMemberFlag",
	"HIDE_UNDOC_MEMBERS",		"HIDE_UNDOC_MEMBERS",
	"FALSE",		"FALSE",
	"hide undocumented members.",		"hide undocumented members.",
	"If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all \n"		"If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all \n"
	"undocumented members inside documented classes or files. \n"		"undocumented members of documented classes, files or namespaces. \n"
			"This option has no effect if EXTRACT_ALL is enabled. \n"
	);		);
	ConfigBool::add( "hideClassFlag",		ConfigBool::add( "hideClassFlag",
	"HIDE_UNDOC_CLASSES",		"HIDE_UNDOC_CLASSES",
	"FALSE",		"FALSE",
	"hide undocumented members.",		"hide undocumented members.",
	"If the HIDE_UNDOC_CLASSESS tag is set to YES, Doxygen will hide all \n"		"If the HIDE_UNDOC_CLASSESS tag is set to YES, Doxygen will hide all \n"
	"undocumented classes. \n"		"undocumented classes that are normally visible in the class hierarchy. \n"
			"This option has no effect if EXTRACT_ALL is enabled. \n"
	);		);
	ConfigBool::add( "briefMemDescFlag",		ConfigBool::add( "briefMemDescFlag",
	"BRIEF_MEMBER_DESC",		"BRIEF_MEMBER_DESC",

doc/commands.doc

+33 −4

Original line number	Original line	Diff line number	Diff line
	@@ -47,6 +47,7 @@ documentation:
	<li> \refitem cmdaddindex \addindex		<li> \refitem cmdaddindex \addindex
	<li> \refitem cmdanchor \anchor		<li> \refitem cmdanchor \anchor
	<li> \refitem cmdarg \arg		<li> \refitem cmdarg \arg
			<li> \refitem cmdattention \attention
	<li> \refitem cmdauthor \author		<li> \refitem cmdauthor \author
	<li> \refitem cmdb \b		<li> \refitem cmdb \b
	<li> \refitem cmdbrief \brief		<li> \refitem cmdbrief \brief
	@@ -97,6 +98,7 @@ documentation:
	<li> \refitem cmdpre \pre		<li> \refitem cmdpre \pre
	<li> \refitem cmdref \ref		<li> \refitem cmdref \ref
	<li> \refitem cmdrelates \relates		<li> \refitem cmdrelates \relates
			<li> \refitem cmdremarks \remarks
	<li> \refitem cmdreturn \return		<li> \refitem cmdreturn \return
	<li> \refitem cmdretval \retval		<li> \refitem cmdretval \retval
	<li> \refitem cmdsa \sa		<li> \refitem cmdsa \sa
	@@ -523,6 +525,18 @@ Public/Protected/Private/... section.
	Section indicators		Section indicators
	\htmlonly --- </center>\endhtmlonly</h2>		\htmlonly --- </center>\endhtmlonly</h2>

			<hr>
			\subsection cmdattention \attention { attention text }

			\addindex \attention
			Starts a paragraph where a message that needs attention may be entered.
			The paragraph will be indented.
			The text of the paragraph has no special internal structure. All visual
			enhancement commands may be used inside the paragraph.
			Multiple adjacent \\attention commands will be joined into a single paragraph.
			The \\attention command ends when a blank line or some other
			sectioning command is encountered.

	\subsection cmdauthor \author { list of authors }		\subsection cmdauthor \author { list of authors }

	\addindex \author		\addindex \author
	@@ -664,7 +678,7 @@ Public/Protected/Private/... section.
	The text of the paragraph has no special internal structure. All visual		The text of the paragraph has no special internal structure. All visual
	enhancement commands may be used inside the paragraph.		enhancement commands may be used inside the paragraph.
	Multiple adjacent \\invariant commands will be joined into a single paragraph.		Multiple adjacent \\invariant commands will be joined into a single paragraph.
	Each warning description will start on a new line.		Each invariant description will start on a new line.
	Alternatively, one \\invariant command may mention		Alternatively, one \\invariant command may mention
	several invariants. The \\invariant command ends when a blank line or some other		several invariants. The \\invariant command ends when a blank line or some other
	sectioning command is encountered.		sectioning command is encountered.
	@@ -712,7 +726,7 @@ Public/Protected/Private/... section.
	The text of the paragraph has no special internal structure. All visual		The text of the paragraph has no special internal structure. All visual
	enhancement commands may be used inside the paragraph.		enhancement commands may be used inside the paragraph.
	Multiple adjacent \\post commands will be joined into a single paragraph.		Multiple adjacent \\post commands will be joined into a single paragraph.
	Each warning description will start on a new line.		Each postcondition will start on a new line.
	Alternatively, one \\post command may mention		Alternatively, one \\post command may mention
	several postconditions. The \\post command ends when a blank line or some other		several postconditions. The \\post command ends when a blank line or some other
	sectioning command is encountered.		sectioning command is encountered.
	@@ -726,11 +740,25 @@ Public/Protected/Private/... section.
	The text of the paragraph has no special internal structure. All visual		The text of the paragraph has no special internal structure. All visual
	enhancement commands may be used inside the paragraph.		enhancement commands may be used inside the paragraph.
	Multiple adjacent \\pre commands will be joined into a single paragraph.		Multiple adjacent \\pre commands will be joined into a single paragraph.
	Each warning description will start on a new line.		Each precondition will start on a new line.
	Alternatively, one \\pre command may mention		Alternatively, one \\pre command may mention
	several preconditions. The \\pre command ends when a blank line or some other		several preconditions. The \\pre command ends when a blank line or some other
	sectioning command is encountered.		sectioning command is encountered.

			<hr>
			\subsection cmdremarks \remarks { remark text }

			\addindex \remarks
			Starts a paragraph where one or more marks may be entered.
			The paragraph will be indented.
			The text of the paragraph has no special internal structure. All visual
			enhancement commands may be used inside the paragraph.
			Multiple adjacent \\remark commands will be joined into a single paragraph.
			Each remark will start on a new line.
			Alternatively, one \\remark command may mention
			several remarks. The \\remark command ends when a blank line or some other
			sectioning command is encountered.

	<hr>		<hr>
	\subsection cmdreturn \return { description of the return value }		\subsection cmdreturn \return { description of the return value }

	@@ -800,7 +828,8 @@ Public/Protected/Private/... section.
	Multiple adjacent \\version commands will be joined into a single paragraph.		Multiple adjacent \\version commands will be joined into a single paragraph.
	Each version description will start on a new line.		Each version description will start on a new line.
	Alternatively, one \\version command may mention		Alternatively, one \\version command may mention
	several dates. The \\version command ends when a blank line or some other		several version strings.
			The \\version command ends when a blank line or some other
	sectioning command is encountered. See section \ref cmdauthor "\\author"		sectioning command is encountered. See section \ref cmdauthor "\\author"
	for an example.		for an example.

Admin message