【问题标题】:How to use doxygen in a project containing both C++ and Python (multi-programming language project)如何在同时包含 C++ 和 Python 的项目中使用 doxygen(多编程语言项目)
【发布时间】:2018-12-30 13:26:37
【问题描述】:

我正在为我的项目创建文档,其中包含用 C++ 和 Python 编写的代码。我可以在我的 C++ 代码上使用 doxygen 生成文档,但是在我拥有以前的文件之后,我找不到对我的 Python 代码执行相同操作的方法。如果我需要两个 doxygen 文档出现在同一个 index.html 下,即将它们合并到一个统一的 doxygen 文件中,我该怎么做?每个人都使用的约定是什么?

【问题讨论】:

  • 请参阅文档章节“记录代码”段落“Python 中的注释块”。只需一次运行即可使用 C++ 和 Python 代码,它会自动运行。
  • 根据 Doxygen 文档,它应该自动获取 *.py*.pyw 文件。只需按照文档中的说明将 Doxygen 命令放入 Python 代码中即可。

标签: python c++ doxygen documentation-generation


【解决方案1】:

首先,感谢albertshawnhcorey 的快速回复。 我尝试了您的建议,并进行了以下修改以从用两种语言编写的文件中解析文档 cmets:

在 Doxyfile 中

INPUT = 包含/my_package/scripts/my_package/

两个目录用空格隔开。

那么,

FILE_PATTERNS = *.h *.py

两个通配符模式也用空格隔开。

回到你放置doxyfile的地方,然后运行

doxygen

你走吧!

【讨论】:

    猜你喜欢
    • 1970-01-01
    • 2014-10-02
    • 1970-01-01
    • 2018-09-22
    • 1970-01-01
    • 1970-01-01
    • 1970-01-01
    • 1970-01-01
    • 1970-01-01
    相关资源
    最近更新 更多