Difference between revisions of "Doxygen Tutorials"

From Macro Wiki
Jump to: navigation, search
(Created page with "This is a simple tutorial with some tips on how to use Doxygen to document codes and how to show the html page. == What is Doxygen == Doxygen is a tool to generate documenta...")
 
Line 1: Line 1:
This is a simple tutorial with some tips on how to use Doxygen to document codes and how to show the html page.
+
This is a simple tutorial with some tips on how to use Doxygen to document codes and how to show the HTML page.
  
 
== What is Doxygen ==
 
== What is Doxygen ==
Line 5: Line 5:
 
Doxygen is a tool to generate documentation from source code. It is primarily used for C++ codes, but it also supports other popular programming languages such as C, Objective-C, C#, PHP, Java, Python, IDL, Fortran, VHDL, Tcl, and to some extent D. You can see more information [http://www.stack.nl/~dimitri/doxygen/ here].
 
Doxygen is a tool to generate documentation from source code. It is primarily used for C++ codes, but it also supports other popular programming languages such as C, Objective-C, C#, PHP, Java, Python, IDL, Fortran, VHDL, Tcl, and to some extent D. You can see more information [http://www.stack.nl/~dimitri/doxygen/ here].
  
== Download Doxygen ==
+
== Download ==
 +
 
 +
You can download the Doxygen [http://www.stack.nl/~dimitri/doxygen/download.html here].
 +
 
 +
== How to document you code ==
 +
 
 +
In order to generate Doxygen documentation, you need to comment the code in a specific way. You can take a look at this [http://www.stack.nl/~dimitri/doxygen/manual/docblocks.html page] to see more information on how to comment your code.
 +
 
 +
== How to see the HTML page on SVN ==
 +
 
 +
When you comment your code using the Doxygen style, after compiling, it generates an HTML page.

Revision as of 19:06, 12 August 2017

This is a simple tutorial with some tips on how to use Doxygen to document codes and how to show the HTML page.

What is Doxygen

Doxygen is a tool to generate documentation from source code. It is primarily used for C++ codes, but it also supports other popular programming languages such as C, Objective-C, C#, PHP, Java, Python, IDL, Fortran, VHDL, Tcl, and to some extent D. You can see more information here.

Download

You can download the Doxygen here.

How to document you code

In order to generate Doxygen documentation, you need to comment the code in a specific way. You can take a look at this page to see more information on how to comment your code.

How to see the HTML page on SVN

When you comment your code using the Doxygen style, after compiling, it generates an HTML page.