[jRtpLib(4)] 生成库帮助文档[TZZ]
1、通过开始菜单,找到并启动“Doxywizard工具”。在其主界面中,选择jthread项目目录作为doxygen工作目录。在项目信息(会显示到文档页面中)一栏中,填入项目名称(jthread)和项目版本(1.3.3)。接着依次指定项目源码目录(即项目目录下的src目录)和文档生成目录(即项目目录下的doc目录)。设置完毕后,点击“Next按钮”进入下一步;
![[jRtpLib(4)] 生成库帮助文档[TZZ]](https://exp-picture.cdn.bcebos.com/fb738d9c2cf7dfb22a9e439fd01b1edef5dc13df.jpg)
2、在“文档模式设置界面”中,选择期望的文档内容提取模式(从代码中提取文档)和需要优化的编程语言类型。设置完毕后,点击“Next按钮”进入下一步;
![[jRtpLib(4)] 生成库帮助文档[TZZ]](https://exp-picture.cdn.bcebos.com/cf6d451b1edef4dc5bbe9eac45ecd3d968750cdf.jpg)
3、在“文档图表设置界面”中,选用内建的类图生成器,然后点击“Next按钮”进入下一步;
![[jRtpLib(4)] 生成库帮助文档[TZZ]](https://exp-picture.cdn.bcebos.com/125ed0ecd3d96975f24c612ad243040149fe09df.jpg)
4、在“运行选项卡页面”中,点击“Run doxygen按钮”执行文档生成操作。稍等片刻后,可以见到输出的文档生成信息;
![[jRtpLib(4)] 生成库帮助文档[TZZ]](https://exp-picture.cdn.bcebos.com/059057299a883913e36d615d26bcbe2f46707cdf.jpg)
![[jRtpLib(4)] 生成库帮助文档[TZZ]](https://exp-picture.cdn.bcebos.com/acfda02f47704618ce526988b08602214e5776df.jpg)
5、关闭“doxywizard”,在弹出的“是否保存配置文件对话框”中,点击“Save按钮”。然后选择Doxygen文件的存放位置;
![[jRtpLib(4)] 生成库帮助文档[TZZ]](https://exp-picture.cdn.bcebos.com/4e168d5653bbf8207d731bb8ba21056105a36edf.jpg)
![[jRtpLib(4)] 生成库帮助文档[TZZ]](https://exp-picture.cdn.bcebos.com/04201aa355e983aec85fd49968efe078153169df.jpg)
6、打开生成的jthread文档目录,找到并双击“index.html”打开文档主页;
![[jRtpLib(4)] 生成库帮助文档[TZZ]](https://exp-picture.cdn.bcebos.com/e1390a31dfb6326c70ee147c89532f63228560df.jpg)
7、在jthread帮助文档页面中,可以查看首页信息、类信息和文件信息(由于jthread库实在太简单,因此作者并没有写文档注释);
![[jRtpLib(4)] 生成库帮助文档[TZZ]](https://exp-picture.cdn.bcebos.com/46a92de039723d038962b335bb486143d6d457df.jpg)
8、按照同样的方式,通过“doxywizard”生成jrtplib库的帮助文档;
![[jRtpLib(4)] 生成库帮助文档[TZZ]](https://exp-picture.cdn.bcebos.com/3fc72e486143d7d47fb989587da75f0f832b50df.jpg)
![[jRtpLib(4)] 生成库帮助文档[TZZ]](https://exp-picture.cdn.bcebos.com/836a6aee1c324b186ea4014253a72633498448df.jpg)
9、通常基于开源库开发时,需要查看编译说明、编译库代码和生成帮助文档。如果需要保证库的稳定性和性能,还需要自己设计并编写压力测试程序。Enjoy!