Doxygen - Revision history

Jciccone at 23:41, 19 March 2009

2009-03-19T23:41:22Z

← Older revision		Revision as of 23:41, 19 March 2009
Line 121:		Line 121:
	\| is a GUI front-end for configuring and running '''doxygen'''.		\| is a GUI front-end for configuring and running '''doxygen'''.
	\|}		\|}

			[[Category:Programming]]

Weibullguy: Formatting

2008-02-18T15:47:37Z

Formatting

@@ Line 18: / Line 18: @@
 * [[Graphviz]]
-== Note to DESTDIR Fans ==
+== Configuration Information ==
-Unfortunately, this package ignores DESTDIR. However, we ''can'' pervert to our purposes the variable that it uses for prefix. The installation commands thus become:
+{|style="text-align: left;"
-  make INSTALL=/usr<DESTDIR>
+{{Note|Doxygen does not use ''DESTDIR''.  Doxygen does recognize the ''INSTALL'' variable that may be used in a manner similar to ''DESTDIR''.  Using the ''INSTALL'' variable, the installation commands would become '''make INSTALL<nowiki>=<DESTDIR>/usr</nowiki>''' and '''make INSTALL<nowiki>=<DESTDIR>/usr DOCDIR=<DESTDIR>/usr/share/doc/doxygen install_docs</nowiki>'''.}}
 == Non-Multilib ==

Chipster19 at 12:32, 5 May 2007

2007-05-05T12:32:20Z

← Older revision		Revision as of 12:32, 5 May 2007
Line 42:		Line 42:
	Compile the package:		Compile the package:

	~~rm src/unistd.h &&~~
	./configure --prefix /usr --docdir /usr/share/doc &&		./configure --prefix /usr --docdir /usr/share/doc &&
	make		make
Line 53:		Line 52:

	make install_docs		make install_docs

	~~=== Command Explanations ===~~

	''rm src/unistd.h'': Flex-2.5.33 has a bug that makes it so that it uses src/unistd.h instead of the version installed on your system. To avoid this, we remove src/unistd.h. Since this fixes a problem with the building of Doxygen's GUI front-end, you don't really need to do this if you're not building the GUI front-end (by using the flag --with-doxywizard), but it doesn't hurt.

	== Multilib ==		== Multilib ==
Line 65:		Line 60:
	Compile the package:		Compile the package:

	~~rm src/unistd.h &&~~
	./configure --prefix /usr --docdir /usr/share/doc &&		./configure --prefix /usr --docdir /usr/share/doc &&
	make CC="gcc ${BUILD32}" CXX="g++ ${BUILD32}"		make CC="gcc ${BUILD32}" CXX="g++ ${BUILD32}"
Line 81:		Line 75:
	Compile the package:		Compile the package:

	~~rm src/unistd.h &&~~
	./configure --prefix /usr --docdir /usr/share/doc &&		./configure --prefix /usr --docdir /usr/share/doc &&
	make CC="gcc ${BUILDN32}" CXX="g++ ${BUILDN32}"		make CC="gcc ${BUILDN32}" CXX="g++ ${BUILDN32}"
Line 97:		Line 90:
	Compile the package:		Compile the package:

	~~rm src/unistd.h &&~~
	./configure --prefix /usr --docdir /usr/share/doc &&		./configure --prefix /usr --docdir /usr/share/doc &&
	make CC="gcc ${BUILD64}" CXX="g++ ${BUILD64}"		make CC="gcc ${BUILD64}" CXX="g++ ${BUILD64}"

Jciccone at 20:36, 16 April 2007

2007-04-16T20:36:22Z

← Older revision		Revision as of 20:36, 16 April 2007
Line 7:		Line 7:
	----		----

	{{Package-Introduction\|Doxygen is a documentation system for C++, C, Java, Objective-C, Python, IDL (Corba and Microsoft flavors) and to some extent PHP, C#, and D.		{{Package-Introduction\|Doxygen is a documentation system for C++, C, Java, Objective-C, Python, IDL (Corba and Microsoft flavors) and to some extent PHP, C#, and D.\|http://www.stack.nl/~dimitri/doxygen/}}

	It can generate an on-line documentation browser (in HTML) and/or an off-line reference manual (in '''L<sup style="position:relative;top:0.25em">A</sup>T<sub><big>E</big></sub>X''') from a set of documented source files. There is also support for generating output in RTF (MS-Word), PostScript, hyperlinked PDF, compressed HTML, and Unix man pages. The documentation is extracted directly from the sources, which makes it much easier to keep the documentation consistent with the source code.

	You can configure doxygen to extract the code structure from undocumented source files. This is very useful to quickly find your way in large source distributions. You can also visualize the relations between the various elements by means of include dependency graphs, inheritance diagrams, and collaboration diagrams, which are all generated automatically.\|http://www.stack.nl/~dimitri/doxygen/}}

	== Dependencies ==		== Dependencies ==

Jciccone at 20:33, 16 April 2007

2007-04-16T20:33:54Z

← Older revision		Revision as of 20:33, 16 April 2007
Line 7:		Line 7:
	----		----

	== Introduction ~~to Doxygen ==~~		{{Package-Introduction\|Doxygen is a documentation system for C++, C, Java, Objective-C, Python, IDL (Corba and Microsoft flavors) and to some extent PHP, C#, and D.

	Doxygen is a documentation system for C++, C, Java, Objective-C, Python, IDL (Corba and Microsoft flavors) and to some extent PHP, C#, and D.

	It can generate an on-line documentation browser (in HTML) and/or an off-line reference manual (in '''L<sup style="position:relative;top:0.25em">A</sup>T<sub><big>E</big></sub>X''') from a set of documented source files. There is also support for generating output in RTF (MS-Word), PostScript, hyperlinked PDF, compressed HTML, and Unix man pages. The documentation is extracted directly from the sources, which makes it much easier to keep the documentation consistent with the source code.		It can generate an on-line documentation browser (in HTML) and/or an off-line reference manual (in '''L<sup style="position:relative;top:0.25em">A</sup>T<sub><big>E</big></sub>X''') from a set of documented source files. There is also support for generating output in RTF (MS-Word), PostScript, hyperlinked PDF, compressed HTML, and Unix man pages. The documentation is extracted directly from the sources, which makes it much easier to keep the documentation consistent with the source code.

	You can configure doxygen to extract the code structure from undocumented source files. This is very useful to quickly find your way in large source distributions. You can also visualize the relations between the various elements by means of include dependency graphs, inheritance diagrams, and collaboration diagrams, which are all generated automatically.		You can configure doxygen to extract the code structure from undocumented source files. This is very useful to quickly find your way in large source distributions. You can also visualize the relations between the various elements by means of include dependency graphs, inheritance diagrams, and collaboration diagrams, which are all generated automatically.\|http://www.stack.nl/~dimitri/doxygen/}}

	~~'''Project Home Page''':~~ http://www.stack.nl/~dimitri/doxygen/

	== Dependencies ==		== Dependencies ==

Kalessin: I added addtional configuration options and added a note about DESTDIR.

2007-02-05T09:51:02Z

I added addtional configuration options and added a note about DESTDIR.

← Older revision		Revision as of 09:51, 5 February 2007
Line 25:		Line 25:
	* [[Ghostscript]]		* [[Ghostscript]]
	* [[Graphviz]]		* [[Graphviz]]

			== Note to DESTDIR Fans ==

			Unfortunately, this package ignores DESTDIR. However, we ''can'' pervert to our purposes the variable that it uses for prefix. The installation commands thus become:

			make INSTALL=/usr<DESTDIR>

			and

			make INSTALL=/usr<DESTDIR> \
			DOCDIR=<DESTDIR>/usr/share/doc/doxygen \
			install_docs

	== Additional Configuration Options ==		== Additional Configuration Options ==

			''--english-only'': Include support for English only.

			''--enable-langs list'': Include support for output languages listed in list. [default: nl,se,cz,fr,id,it,de,jp,je,es,fi,ru,hr,pl,pt,hu,kr,ke,ro,si,cn,no,br,dk,sk,ua,gr,tw,sr,ca,lt,za,ar,fa]

	''--with-doxywizard'': If Qt is installed, you can use this flag to cause Doxygen's GUI front-end to be built.		''--with-doxywizard'': If Qt is installed, you can use this flag to cause Doxygen's GUI front-end to be built.
Line 48:		Line 64:
	=== Command Explanations ===		=== Command Explanations ===

	''rm src/''unistd.h: Flex-2.5.33 has a bug that ~~causes make to use this file~~ instead of the system ~~installed version~~. ~~Removing~~ this ~~file allows~~ the GUI front-end to ~~build successfully. This command is not required~~ if you ~~don~~'~~t pass~~ the ''--with-doxywizard ~~parameter'' (~~but ~~won~~'t ~~affect the build otherwise)~~.		''rm src/unistd.h'': Flex-2.5.33 has a bug that makes it so that it uses src/unistd.h instead of the version installed on your system. To avoid this, we remove src/unistd.h. Since this fixes a problem with the building of Doxygen's GUI front-end, you don't really need to do this if you're not building the GUI front-end (by using the flag --with-doxywizard), but it doesn't hurt.

	== Multilib ==		== Multilib ==

Kalessin: I filled in the package description.

2007-01-30T10:12:18Z

I filled in the package description.

← Older revision		Revision as of 10:12, 30 January 2007
Line 9:		Line 9:
	== Introduction to Doxygen ==		== Introduction to Doxygen ==

	<~~Package Description Needed~~>		Doxygen is a documentation system for C++, C, Java, Objective-C, Python, IDL (Corba and Microsoft flavors) and to some extent PHP, C#, and D.

			It can generate an on-line documentation browser (in HTML) and/or an off-line reference manual (in '''L<sup style="position:relative;top:0.25em">A</sup>T<sub><big>E</big></sub>X''') from a set of documented source files. There is also support for generating output in RTF (MS-Word), PostScript, hyperlinked PDF, compressed HTML, and Unix man pages. The documentation is extracted directly from the sources, which makes it much easier to keep the documentation consistent with the source code.

			You can configure doxygen to extract the code structure from undocumented source files. This is very useful to quickly find your way in large source distributions. You can also visualize the relations between the various elements by means of include dependency graphs, inheritance diagrams, and collaboration diagrams, which are all generated automatically.

			'''Project Home Page''': http://www.stack.nl/~dimitri/doxygen/

	== Dependencies ==		== Dependencies ==

Jim: /* Introduction to Doxygen */

2007-01-12T06:15:21Z

Introduction to Doxygen

← Older revision		Revision as of 06:15, 12 January 2007
Line 9:		Line 9:
	== Introduction to Doxygen ==		== Introduction to Doxygen ==

	Doxygen is a documentation system for C++, C, Java, Objective-C, Python, IDL (Corba and Microsoft flavors) and to some extent PHP, C#, and D. It can generate an on-line documentation browser (in HTML) and/or an off-line reference manual (in '''L<~~sup style="position:relative;top:0.25em"~~>A</sup>T<sub><big>E</big></sub>X''') from a set of documented source files. There is also support for generating output in RTF (MS-Word), PostScript, hyperlinked PDF, compressed HTML, and Unix man pages. The documentation is extracted directly from the sources, which makes it much easier to keep the documentation consistent with the source code.		<Package Description Needed>

	You can also configure doxygen to extract the code structure from undocumented source files. This is very useful to quickly find your way in large source distributions. When used with Graphviz, you can also visualize the relations between the various elements by means of include dependency graphs, inheritance diagrams, and collaboration diagrams, which are all generated automatically.

	== Dependencies ==		== Dependencies ==

Kalessin: I added the "Contents" section.

2006-12-18T00:59:33Z

I added the "Contents" section.

@@ Line 1: / Line 1: @@
 {| style="text-align: left; background-color: AliceBlue;"
-|-
+|-valign="top"
 !Download Source:
 | ftp://ftp.stack.nl/pub/users/dimitri/doxygen-{{Doxygen-Version}}.src.tar.gz
@@ Line 9: / Line 9: @@
 == Introduction to Doxygen ==
-The Doxygen package contains a documentation system for C++, C, Java, Objective-C, Corba IDL and to some extent PHP, C# and D. This is useful for generating HTML documentation and/or an off-line reference manual from a set of documented source files. There is also support for generating output in RTF, PostScript, hyperlinked PDF, compressed HTML, and Unix man pages. The documentation is extracted directly from the sources, which makes it much easier to keep the documentation consistent with the source code.
+Doxygen is a documentation system for C++, C, Java, Objective-C, Python, IDL (Corba and Microsoft flavors) and to some extent PHP, C#, and D. It can generate an on-line documentation browser (in HTML) and/or an off-line reference manual (in '''L<sup style="position:relative;top:0.25em">A</sup>T<sub><big>E</big></sub>X''') from a set of documented source files. There is also support for generating output in RTF (MS-Word), PostScript, hyperlinked PDF, compressed HTML, and Unix man pages. The documentation is extracted directly from the sources, which makes it much easier to keep the documentation consistent with the source code.
-You can also configure Doxygen to extract the code structure from undocumented source files. This is very useful to quickly find your way in large source distributions. Used along with Graphviz, you can also visualize the relations between the various elements by means of include dependency graphs, inheritance diagrams, and collaboration diagrams, which are all generated automatically.
+You can also configure doxygen to extract the code structure from undocumented source files. This is very useful to quickly find your way in large source distributions. When used with Graphviz, you can also visualize the relations between the various elements by means of include dependency graphs, inheritance diagrams, and collaboration diagrams, which are all generated automatically.
 == Dependencies ==
@@ Line 21: / Line 21: @@
 * [[Ghostscript]]
 * [[Graphviz]]
 == Non-Multilib ==
@@ Line 37: / Line 41: @@
   make install_docs
 == Multilib ==
@@ Line 88: / Line 96: @@
   make install_docs

Jciccone at 22:20, 17 December 2006

2006-12-17T22:20:12Z

← Older revision		Revision as of 22:20, 17 December 2006
Line 2:		Line 2:
	\|-		\|-
	!Download Source:		!Download Source:
	\| ftp://ftp.stack.nl/pub/users/dimitri/doxygen-~~1.5.0~~.src.tar.gz		\| ftp://ftp.stack.nl/pub/users/dimitri/doxygen-{{Doxygen-Version}}.src.tar.gz
	\|}		\|}