Doxygen的使用

安装着Doxygen和Graphviz这两个东西

  • 在源码目录先使用doxygen -g生成一个叫 ‘Doxyfile’ 的Doxygen的配置文件
  • 修改配置文件，里面都有介绍各个选项的功能，这里主要修改一下几个:
    HAVE_DOT = YES
    EXTRACT_ALL = YES
    EXTRACT_PRIVATE = YES
    EXTRACT_STATIC = YES
    CALL_GRAPH = YES
  • 然后直接doxygen Doxyfile就可以看到多了一个html和latex文件夹
  • brew install –cask mactex-no-gui
  • 在latex文件下面直接make生成的pdf(也可以直接就看html了)
  • GENERATE_TREEVIEW=YES从而进行树形结构展示

存在的问题

不显示二级目录下的py文件

The RECURSIVE tag can be used to specify whether or not subdirectories should be searched for input files as well.The default value is: NO.RECURSIVE= YES

latex中的refman.pdf不存在或者无法打开

应该是中文字符串的原因

（在make的时候会进入latex，exit+:qa可以退出latex）

参考

官方文档：

https://www.doxygen.nl/manual/starting.html

参考链接：

https://zhuanlan.zhihu.com/p/59762344