Doxygen - Revision history

Admin: /* Installing */

2013-06-04T17:40:49Z

Installing

← Older revision		Revision as of 17:40, 4 June 2013
Line 25:		Line 25:

	Doxygen uses "dot", part of Graphviz visualization software, for producing diagrams. This software has a binary installer for common platforms, and is open-source. "dot" should be installed and available on the path, so when you type <code>$ which dot</code> you should see a location returned. Typically it's located in <code>/usr/local/bin/dot</code>.		Doxygen uses "dot", part of Graphviz visualization software, for producing diagrams. This software has a binary installer for common platforms, and is open-source. "dot" should be installed and available on the path, so when you type <code>$ which dot</code> you should see a location returned. Typically it's located in <code>/usr/local/bin/dot</code>.

			==Installing on Mac OS X Lion==

			Ran into a slew of difficulties compiling, due to invalid flags and libraries compiled with incompatible compilers.

			This is due to Apple once again putting its head up its own ass by moving away from GCC and toward whatever compiler-of-the-month they think is better.

			Thanks for nothing, Apple.

	= Using Doxygen =		= Using Doxygen =

Admin: /* Configuring */

2012-05-25T19:34:02Z

Configuring

← Older revision		Revision as of 19:34, 25 May 2012
Line 19:		Line 19:

	./configure \		./configure \
	--prefix=/path/to/doxygen		--prefix /path/to/doxygen
	</syntaxhighlight>		</syntaxhighlight>

Admin at 15:59, 28 May 2011

2011-05-28T15:59:52Z

← Older revision		Revision as of 15:59, 28 May 2011
Line 1:		Line 1:
	Doxygen is a documentation system for C/C++/Fortran/Python/Java/PHP/etc. It works by parsing special comment blocks and assembling the information into nice, polished documentation.		Doxygen is a documentation system for C/[[C++]]/Fortran/[[Python]]/Java/[[PHP]]/etc. It works by parsing special comment blocks and assembling the information into nice, polished documentation.

	Doxygen has the HUGE advantage of allowing code documentation through comments in the code, which are easy to add and keep up to date, rather than programmers having to labor to create stand-alone documentation that will quickly grow stale. Additionally, even without parsing comments, Doxygen still provides information about the workings of the code.		Doxygen has the HUGE advantage of allowing code documentation through comments in the code, which are easy to add and keep up to date, rather than programmers having to labor to create stand-alone documentation that will quickly grow stale. Additionally, even without parsing comments, Doxygen still provides information about the workings of the code.
Line 44:		Line 44:


	[[Category:~~Computers~~]]		{{Programs}}
	[[Category:~~Programs~~]]
			[[Category:C++]]
			[[Category:Python]]

Admin at 00:21, 20 May 2011

2011-05-20T00:21:02Z

← Older revision		Revision as of 00:21, 20 May 2011
Line 3:		Line 3:
	Doxygen has the HUGE advantage of allowing code documentation through comments in the code, which are easy to add and keep up to date, rather than programmers having to labor to create stand-alone documentation that will quickly grow stale. Additionally, even without parsing comments, Doxygen still provides information about the workings of the code.		Doxygen has the HUGE advantage of allowing code documentation through comments in the code, which are easy to add and keep up to date, rather than programmers having to labor to create stand-alone documentation that will quickly grow stale. Additionally, even without parsing comments, Doxygen still provides information about the workings of the code.

	See [[wikipedia:Doxygen]] for more info. See http://www.uintah.utah.edu/trac/doxygen/classes.html for an example.		See [[wikipedia:Doxygen]] for more info. See http://www.uintah.utah.edu/trac/doxygen/classes.html for a (rather mediocre) example of what can be done.

	= Installing =		= Installing =

Admin: /* Prerequisites */

2010-10-05T07:56:39Z

Prerequisites

← Older revision		Revision as of 07:56, 5 October 2010
Line 22:		Line 22:
	</syntaxhighlight>		</syntaxhighlight>

	== ~~Prerequisites~~ ==		== Dependencies ==

	Doxygen uses "dot", part of Graphviz visualization software, for producing diagrams. This software has a binary installer for common platforms, and is open-source. "dot" should be installed and available on the path, so when you type <code>$ which dot</code> you should see a location returned. Typically it's located in <code>/usr/local/bin/dot</code>.		Doxygen uses "dot", part of Graphviz visualization software, for producing diagrams. This software has a binary installer for common platforms, and is open-source. "dot" should be installed and available on the path, so when you type <code>$ which dot</code> you should see a location returned. Typically it's located in <code>/usr/local/bin/dot</code>.



	= Using Doxygen =		= Using Doxygen =

Admin: /* Configuring */

2010-10-05T07:45:03Z

Configuring

← Older revision		Revision as of 07:45, 5 October 2010
Line 13:		Line 13:
	<syntaxhighlight lang="bash">		<syntaxhighlight lang="bash">
	#!/bin/sh		#!/bin/sh
			#
			# run configure
			# make
			# make install

	./configure \		./configure \

Admin: /* Using Doxygen */

2010-10-05T07:44:35Z

Using Doxygen

← Older revision		Revision as of 07:44, 5 October 2010
Line 26:		Line 26:
	= Using Doxygen =		= Using Doxygen =

	The Doxygen manual ([http://www.stack.nl/~dimitri/doxygen/manual.html]) is exhaustive, and there's no point in reproducing it here.		The Doxygen manual [http://www.stack.nl/~dimitri/doxygen/manual.html] is exhaustive, and there's no point in reproducing it here.

	Doxygen works by commenting your code using special blocks. Many examples are available here: http://www.stack.nl/~dimitri/doxygen/docblocks.html		Doxygen works by commenting your code using special blocks. Many examples are available here: http://www.stack.nl/~dimitri/doxygen/docblocks.html

Admin at 07:44, 5 October 2010

2010-10-05T07:44:15Z

← Older revision		Revision as of 07:44, 5 October 2010
Line 3:		Line 3:
	Doxygen has the HUGE advantage of allowing code documentation through comments in the code, which are easy to add and keep up to date, rather than programmers having to labor to create stand-alone documentation that will quickly grow stale. Additionally, even without parsing comments, Doxygen still provides information about the workings of the code.		Doxygen has the HUGE advantage of allowing code documentation through comments in the code, which are easy to add and keep up to date, rather than programmers having to labor to create stand-alone documentation that will quickly grow stale. Additionally, even without parsing comments, Doxygen still provides information about the workings of the code.

	See [[wikipedia:Doxygen]] for more info. See ~~https~~://~~software~~.~~crsim~~.utah.edu/trac/doxygen/ for ~~some examples~~.		See [[wikipedia:Doxygen]] for more info. See http://www.uintah.utah.edu/trac/doxygen/classes.html for an example.

	= Installing =		= Installing =

Admin at 07:43, 5 October 2010

2010-10-05T07:43:21Z

@@ Line 1: / Line 1: @@
-See [[wikipedia:Doxygen]] for a high-level description of Doxygen.
+Doxygen is a documentation system for C/C++/Fortran/Python/Java/PHP/etc.  It works by parsing special comment blocks and assembling the information into nice, polished documentation.
 = Installing =
@@ Line 17: / Line 21: @@
 Doxygen uses "dot", part of Graphviz visualization software, for producing diagrams.  This software has a binary installer for common platforms, and is open-source.  "dot" should be installed and available on the path, so when you type <code>$ which dot</code> you should see a location returned.  Typically it's located in <code>/usr/local/bin/dot</code>.

Admin: Created page with "See wikipedia:Doxygen for a high-level description of Doxygen. = Installing = == Configuring == Doxygen didn't need any special configure options the way I installed it: ..."

2010-10-05T07:33:49Z

Created page with "See wikipedia:Doxygen for a high-level description of Doxygen. = Installing = == Configuring == Doxygen didn't need any special configure options the way I installed it: ..."

New page

See [[wikipedia:Doxygen]] for a high-level description of Doxygen.

= Installing =

== Configuring ==

Doxygen didn't need any special configure options the way I installed it:

<syntaxhighlight lang="bash">
#!/bin/sh

./configure \
--prefix=/path/to/doxygen
</syntaxhighlight>

== Prerequisites ==

Doxygen uses "dot", part of Graphviz visualization software, for producing diagrams. This software has a binary installer for common platforms, and is open-source. "dot" should be installed and available on the path, so when you type <code>$ which dot</code> you should see a location returned. Typically it's located in <code>/usr/local/bin/dot</code>.