Generate code documents with Doxygen+graphviz Automation (with detailed tutorials)

First, the Primer

With these two tools you can automatically traverse the code, and generate code documents, we first look at the effect, and then release the two tools.

Second, the tool

Doxygen:http://www.stack.nl/~dimitri/doxygen/download.html

graphviz:http://www.graphviz.org/

Third, the use of steps

Install Doxygen First, then unzip the downloaded Graphviz. Then open the Doxygen and follow the diagram below.

The last point of run will be all right.

Attach some of the annotations that Doxygen can identify, which are only more commonly used, not all. For the sake of clarity, I pasted the notes and the code together.

 Packagecom.example.kale.myapplication;/*** Created by Jack Tony on 2015/4/3. * @brief What this class does*/ Public classTestClass {///Enumeration  enumTYPE {type_01,/*!< Enumeration Entries*/type_02,///< Enumeration Entries    }; /*** * <pre><b>copyright:kale</b></pre> * <pre><b>email: </b>[em Ail protected]</pre> * <pre><b>company: </b>http://www.cnblogs.com/tianzhijiexian/</pre> * <pre><b>all Rights reserved.</b></pre> *@seeReference Itemshttp://www.cnblogs.com/tianzhijiexian/* Simple Description of @brief method *@authorAuthor's information * @date 2011/8/24 8:37:56 *@version0.1 * @retval C describes the type of return value * @note annotations, which can be detailed annotations * @remarks notes (remaks) * @attention considerations (ATTENTION) * @warning warning message *@parama description of parameter A *@paramdescription of b parameter B *@returnThis function returns the execution result * *@throwsException*/     PublicString TestFunction (intA, String b)throwsexception{return"Hello World"; }}

Test results for output:

Detailed steps for picture download:http://download.csdn.net/detail/shark0017/8564357

Reference from:

http://blog.csdn.net/liuxuezong/article/details/6713807
Http://www.cnblogs.com/homezzm/archive/2013/07/02/3166602.html
Http://wenku.baidu.com/link?url=XtIQOfIvSriE9_ Mwdqhxspfxm9oavpcwcwklunbvir7im9fvkby9zb2-zdjispt0obgs8gh12nxvs02orj54sj3_s_n-uleyofaaif29xcg
http://www.xjtudll.cn/Exp/245/

Generate code documents with Doxygen+graphviz Automation (with detailed tutorials)