来自复杂又篮球的回答
2023-12-11 14:36:37
在UE4安装目录下有自带的html文档:Engine\Documentation\Builds\CppAPI-HTML.tgz,解压后在en-US\API子目录下。
1、首先需要安装Doxygen,官网打开后开始进行配置。
2、在Wizard>Project只需要设置输出目录并勾选Scan recursively(源代码目录后面再设置).
3、Wizard>Mode勾选All Entities和Optimize for C++。
4Wizard>Output选择prepare for chm和With search function。
5、Diagram是生成类图,勾选后会生成比较大的文件,很耗时。
6、Expert页面可以选择创建子目录,然后拉到最下面。
7、要把这两项都设大一些,不然速度很慢而且很可能崩溃。
8、Input设置如上,其实只要Runtime目录下的基本就可以了,只需要解析头文件,还有Private目录的文件也不需要解析,这样也可以加快生成速度。
9、Source Browser可以取消勾选VERBATIM_HEADERS,勾选的话会将所有头文件复制一份,方便直接从文档跳转到头文件,但是文档会很臃肿。
10、HTML页面要勾选生成HTMLHELP,然后指定生成的文件名,HHC_LOCATION在。
11、C:/Program Files (x86)/HTML Help Workshop/hhc.exe。
12、左边最底下Dot页也推荐取消生成类图,非常耗时。
13、最后到Run页面运行即可。
文章整理自网络,仅供学习参考,版权归属原作所有
推荐问答