Difference between revisions of "Doxygen Tutorials"

From Macro Wiki
Jump to: navigation, search
Line 20: Line 20:
 
[[File:html.png]]
 
[[File:html.png]]
  
However, you may want to see the result of the HTML page, not its code. A way to do that is to look at the Source Forge site using the [https://sourceforge.net/p/forge/documentation/svn/#anonymous-access-read-only Anonymous Access]. Basically, using the Anonymous Access you have access to a ready only page, where you can visualize the result of the HTML.
+
However, you may want to see the result of the HTML page, not its code. A way to do that is to look at the Source Forge site using the [https://sourceforge.net/p/forge/documentation/svn/#anonymous-access-read-only Anonymous Access]. Basically, using the Anonymous Access you have access to a ready-only page, where you can visualize the result of the HTML.
You can access to the Source Forge project in this way using:
+
You can access the Source Forge project in this way using:
  
 
https://svn.code.sf.net/p/PROJECTNAME/REPOSITORY/  
 
https://svn.code.sf.net/p/PROJECTNAME/REPOSITORY/  
 +
 +
If your project has sub-projects, you will need to use:
 +
 +
https://svn.code.sf.net/p/PROJECTNAME/SUBPROJECT/REPOSITORY/
  
 
After to be in you repository page, you only need to find the page with de Doxygen documentation and click on the 'index.html' file.
 
After to be in you repository page, you only need to find the page with de Doxygen documentation and click on the 'index.html' file.
  
 
==== Example: ====
 
==== Example: ====

Revision as of 21:26, 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 SourceForge

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

If you try to see the HTML page in the Source Forge site, it will only show the HTML code: Html.png

However, you may want to see the result of the HTML page, not its code. A way to do that is to look at the Source Forge site using the Anonymous Access. Basically, using the Anonymous Access you have access to a ready-only page, where you can visualize the result of the HTML. You can access the Source Forge project in this way using:

https://svn.code.sf.net/p/PROJECTNAME/REPOSITORY/

If your project has sub-projects, you will need to use:

https://svn.code.sf.net/p/PROJECTNAME/SUBPROJECT/REPOSITORY/

After to be in you repository page, you only need to find the page with de Doxygen documentation and click on the 'index.html' file.

Example: