Configuring and Using Doxygen - Revision history

Missing actor at 10:46, 18 January 2011

2011-01-18T10:46:09Z

← Older revision		Revision as of 16:16, 18 January 2011
Line 6:		Line 6:

	1. It can generate an on-line documentation browser (in HTML) and/or an off-line reference manual (in $\mbox{\LaTeX}$) from a set of documented source files.		1. It can generate an on-line documentation browser (in HTML) and/or an off-line reference manual (in $\mbox{\LaTeX}$) from a set of documented source files.
	There is also support for generating output in 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.		There is also support for generating output in 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.

	2. We can configure doxygen to extract the code structure from undocumented source files. This is very useful to quickly find our way in large source distributions.		2. We can configure doxygen to extract the code structure from undocumented source files. This is very useful to quickly find our way in large source distributions.

Missing actor at 10:45, 18 January 2011

2011-01-18T10:45:41Z

← Older revision		Revision as of 16:15, 18 January 2011
Line 5:		Line 5:
	It can help in three ways:		It can help in three ways:

	1. It can generate an on-line documentation browser (in HTML) and/or an off-line reference manual (in $\mbox{\LaTeX}$) from a set of documented source files. There is also support for generating output in 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.		1. It can generate an on-line documentation browser (in HTML) and/or an off-line reference manual (in $\mbox{\LaTeX}$) from a set of documented source files.
			There is also support for generating output in 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.

	2. We can configure doxygen to extract the code structure from undocumented source files. This is very useful to quickly find our way in large source distributions. We 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.		2. We can configure doxygen to extract the code structure from undocumented source files. This is very useful to quickly find our way in large source distributions.
			We 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.

	3. It boosts the reading and understanding of the code due to visualization.		3. It boosts the reading and understanding of the code due to visualization.

Missing actor: /* Using and configuring the Doxygen */

2011-01-18T10:43:33Z

Using and configuring the Doxygen

← Older revision		Revision as of 16:13, 18 January 2011
Line 20:		Line 20:
	2. Then go to the directory where source files are kept. For example, in our case we go to the <>/src/ directory.		2. Then go to the directory where source files are kept. For example, in our case we go to the <>/src/ directory.

	3. Run command doxygen -g which will generate the file "~~doxyfile~~"		3. Run command doxygen -g which will generate the file "Doxyfile"

	4. Now we can configure the doxygen as per our need using this "~~doxyfile~~".		4. Now we can configure the doxygen as per our need using this "Doxyfile".

	For Example,		For Example,
Line 30:		Line 30:
	If we set CALL_GRAPH = YES it will generate a dependency graph for functions and methods.		If we set CALL_GRAPH = YES it will generate a dependency graph for functions and methods.

	5. When you are done with the editing the ~~doxyfile~~, run the command		5. When you are done with the editing the Doxyfile, run the command

	doxygen ~~doxyfile~~		doxygen Doxyfile

	6. This will create the all documentation and diagrams as per the ~~doxyfile~~.		6. This will create the all documentation and diagrams as per the Doxyfile.

	7. Now you can browse the code by going to the html directory generated in the source files' directory and opening index.html in browser.		7. Now you can browse the code by going to the html directory generated in the source files' directory and opening index.html in browser.

	~~8. This is the [[sample doxyfile]] which we used for our project for your refenrence.~~

	== References ==		== References ==

Missing actor: /* Using and configuring the Doxygen */

2011-01-18T10:37:15Z

Using and configuring the Doxygen

← Older revision		Revision as of 16:07, 18 January 2011
Line 38:		Line 38:
	7. Now you can browse the code by going to the html directory generated in the source files' directory and opening index.html in browser.		7. Now you can browse the code by going to the html directory generated in the source files' directory and opening index.html in browser.

			8. This is the [[sample doxyfile]] which we used for our project for your refenrence.

	== References ==		== References ==

Missing actor: Created page with "== Introduction == Doxygen is a documentation system for C++, C, Java, Objective-C, Python, IDL (Corba and Microsoft flavors), Fortran, VHDL, PHP, C#, and to some extent D. It ..."

2011-01-18T10:30:25Z

Created page with "== Introduction == Doxygen is a documentation system for C++, C, Java, Objective-C, Python, IDL (Corba and Microsoft flavors), Fortran, VHDL, PHP, C#, and to some extent D. It ..."

New page

== Introduction ==

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

It can help in three ways:

1. It can generate an on-line documentation browser (in HTML) and/or an off-line reference manual (in $\mbox{\LaTeX}$) from a set of documented source files. There is also support for generating output in 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.

2. We can configure doxygen to extract the code structure from undocumented source files. This is very useful to quickly find our way in large source distributions. We 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.

3. It boosts the reading and understanding of the code due to visualization.

Previously I thought that we can edit the code using doxygen. But we can not edit the code but can just browse the code using doxygen, which is the disadvantage of using the doxygen.

== Using and configuring the Doxygen ==

1. Firstly we have to install package doxygen.

2. Then go to the directory where source files are kept. For example, in our case we go to the <>/src/ directory.

3. Run command doxygen -g which will generate the file "doxyfile"

4. Now we can configure the doxygen as per our need using this "doxyfile".

For Example,
If we set the EXTRACT_ALL = YES then, it will extract documentation even from those elements we haven't yet commented.
If we set INLINE_SOURCE = YES then it will extract the relevant parts of the source and associate them with our description.
If we set HAVE_DOT = YES then it will use Graphviz for class and collaboration diagrams.
If we set CALL_GRAPH = YES it will generate a dependency graph for functions and methods.

5. When you are done with the editing the doxyfile, run the command

doxygen doxyfile

6. This will create the all documentation and diagrams as per the doxyfile.

7. Now you can browse the code by going to the html directory generated in the source files' directory and opening index.html in browser.

== References ==

[http://www-scf.usc.edu/~peterchd/doxygen/ http://www-scf.usc.edu/~peterchd/doxygen/]

[http://www.stack.nl/~dimitri/doxygen/manual.html http://www.stack.nl/~dimitri/doxygen/manual.html]