Configuring and Using Doxygen: Difference between revisions

(2 intermediate revisions by the same user not shown)

Line 5:

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.

Line 20:

Line 23:

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,

Line 30:

Line 33:

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.

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

== References ==

@@ Line 5: / Line 5: @@
 It can help in three ways:
-. 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.
+. 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.
-. 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.
+. 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.
 . It boosts the reading and understanding of the code due to visualization.
@@ Line 20: / Line 23: @@
 . Then go to the directory where source files are kept. For example, in our case we go to the <>/src/  directory.
-. Run command doxygen -g which will generate the file "doxyfile"
+. Run command doxygen -g which will generate the file "Doxyfile"
-. Now we can configure the doxygen as per our need using this "doxyfile".
+. Now we can configure the doxygen as per our need using this "Doxyfile".
 For Example,
@@ Line 30: / Line 33: @@
     If we set CALL_GRAPH = YES it will generate a dependency graph for functions and methods.
-. When you are done with the editing the doxyfile, run the command
+. When you are done with the editing the Doxyfile, run the command
-           doxygen doxyfile
+           doxygen Doxyfile
-. This will create the all documentation and diagrams as per the doxyfile.
+. This will create the all documentation and diagrams as per the Doxyfile.
 . Now you can browse the code by going to the html directory generated in the source files' directory and opening index.html in browser.
-. This is the [[sample doxyfile]] which we used for our project for your refenrence.
 == References ==