简介
使用ipad阅读代码
https://www.zhihu.com/collection/64510384
https://www.cnblogs.com/benjamin-t/p/3618787.html
下面进行补充
安装完doxygen后即可进行适当的配置,然后运行doxyfile生成文档。基本的配置前人早有说明,不再赘述。需要注意的是:
1.要勾选Dot选项卡下面的HAVE_DOT、CALL_GRAPH 、CALLER_GRAPH 选项。并在DOT_PATH下面填入dot.exe的路径,也就是graphviz安装目录下的bin文件夹。
2.勾选Wizard->Project选项卡下面的Scan recursively!
3.勾选Build选项卡下面的EXTRACT_ALL、EXTRACT_PRIVATE、EXTRACT_STATIC、EXTRACT_LOCAL_CLASSES、EXTRACT_LOCAL_METHODS选项
4.如果程序里面有中文,将Project选项卡下的DOXYFILE_ENCODING和Input选项卡下面的INPUT_ENCODING改为GBK
5.可以勾掉LATEX输出,这样节省编译时间
在linux上成功了在windows上失败了
INPUT = protobuf-2.5.0/src (设置项目源代码目录的路径,相对于Doxyfile的位置)
PROJECT_NAME = "ProtoBuf" (项目名默认为My Project)
OUTPUT_DIRECOTRY = doc (设置文档输出路径,相对于Doxyfile的位置)
RECURSIVE = YES (设置递归查找所有子目录,默认NO只查找当前目录)
EXTRACT_ALL = YES (设置抽取代码中所有实体,默认NO只抽取有doxygen注释的实体)
SOURCE_BROWSER = YES (生成交叉引用)
INLINE_SOURCES = YES (将源代码包含进文档,默认NO只包含声明,不包含定义)
OUTPUT_LANGUAGE = Chinese (设置文档语言为中文)
Tips
记得在latex目录下使用make来生成最终版。