用Doxygen为objective-c代码生成文档

原文见： http://www.dreamingwish.com/dream-2011/use-doxygen-to-generate-documentation-objective-c-code.html

用Doxygen为objective-c代码生成文档

从xcode3升级到xcode4后，那一堆Header Doc选项没了

xcode3的Header Doc加命令行方式生成的文档是基于注释的，而且逻辑整理功能很薄弱。

Doxygen很强大，1.7.5.1版本对objective-c的支持已经很完善了，我们真幸福啊~

简单说说整个流程吧：

到sourceforge上下载dmg，其实我倒更喜欢源码编译方式，那种自由感~
http://sourceforge.net/projects/doxygen/files/rel-1.7.5.1/
加载dmg后，把.app文件拖入应用程序文件夹即可

打开doxygen，先简单设置一下：

Step 1里面选择生成文档的目录

step2里面：





project synopsis：工程概述，可以填中文的

Scan recursively：选上，读取所有子文件夹





All Entities选上不然生成过程中会有一堆警告,它会跳过哪些没有文档注释的成员等

Include cross-reference…..：太长了懒得打，让文档交叉引用源代码

optimize：优化就选c++吧，没有更好的选择了





HTML：生成HTML文档

with navigation panel:加上导航栏吧，挺好用的，就不要选chm，这玩意儿 – -

With search function:搜索功能，多强大的东西，一定要。

LaTeX：这个就不要了，HTML就够了

其他Man pages，RTF，XML在HTML面前都是浮云，Man page么。。也用不着

Diagrams里面就选built-in类图生成器，dot tool很帅，试试也无妨，但是要先安装graphviz。然后在Expert->Dot里面的DOT_PATH里面填/usr/local/bin





EXTRACT_PRIVATE和EXTRACT_STATIC：即使选择了EXTRACT_ALL，这俩也需要额外选中，才会生效

EXTARCT_LOCAL_METHODS:这个如果不选中的话，.m文件里面的局域函数不会被解析，类似viewDidLoad这种没有头文件声明的（这个选项可是objective-c专用的）

向下拖动滚动条，还有：

FORCE_LOCAL_INCLUDES:让生成的文档的头文件引用使用双引号而非大于小于号，这个选中吧，大于小于号可是用来引用标准库的

其他超多的选项，自行研究吧 – -