将参数从boost程序选项导出到doxygen

时间:2013-12-25 19:46:54

标签: c++ boost doxygen boost-program-options

我正在编写一个带有升级程序选项协调的命令行选项的工具。 Doxygen已经详细记录了API,但我希望Doxygen还记录从boost program_options变量中提取信息的工具的命令行选项。这将使HTML对用户也有用,而不仅仅是开发人员。

有人知道boost program_options和doxygen之间是否存在这样的集成?如果没有,是否有其他工具可以根据boost program_options生成HTML命令行用法?

1 个答案:

答案 0 :(得分:1)

这是一个简单的方法,我在我的doxygen文档中包含了我的应用程序的boost :: program_options文档:

  1. 使用--help选项运行可执行文件,并将输出发送到文本文件。
  2. 然后在您的某个源文件的doxygen文档中,使用\ verbinclude命令引入您创建的文本文件。
  3. 它没有HTML格式,但它完成了这项工作。

    我个人将这些步骤放在我的Makefile中的“docs”目标下,而不是编写脚本。