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

Question

我正在编写一个工具，其命令行选项由 boost 程序选项协调。 Doxygen 对 API 进行了很好的记录，但我希望 Doxygen 也记录从 boost program_options 变量中提取信息的工具的命令行选项。这将使 HTML 对用户也有用，而不仅仅是开发人员。

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

Answer 1

这是我将应用程序的 boost::program_options 文档包含在我的 doxygen 文档中的一种简单方法：

1. 使用 --help 选项运行可执行文件，并将输出发送到文本文件。
2. 然后在您的一个源文件中的 doxygen 文档中，使用 \verbinclude 命令引入您创建的文本文件。

它没有 HTML 格式，但可以胜任。

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