doxygen-＆gt; doxy2swig-＆gt; PDOC导致重复的类docstrings

Question

我有一个C ++标头文件（.H），该文件（通过SWIG）为我生成一个Python模块。我的目标是在生成的.py文件中包含来自.h文件的doxygen文档，但是由于我目前无法使用通过SWIG支持这一点的最新SWIG（V4+），所以我使用doxygen和doxy2swig来实现这一目标。

我的过程如下：

• 在.h文件上运行doxygen以生成xml输出
• 在xml输出上运行doxy2swig，以生成一个带有％docString insertion
• 更新我的project my project my file
• swig on。 生成的。
• 包括在生成的.py文件上运行pdoc的

doxy2swig ，导致重复的描述。

我正在寻找一种做以下方法之一的方法：

• 强制doxy2swig仅在类或_ init
• 强制pdoc忽略类或__ init __ init __ init __

我已经尝试过的情况查看：

• __ PDOC __ [class .__ Int __] = false。这是行不通的，即使这样做也意味着将我所有的课程添加到此范围内。
• 手动修改了Doxy2swig生成的.i文件以将DOCSTRING附加到类。 init 而不是类。这是一种无效的格式。
• 找不到任何可以帮助我的PDOC或doxy2swig参数 - 希望与我认为存在的类似的sphinx选项相似，这些选项将类文档排除在生成的文档中，或者排除__ INT __ INT __ INT __ INT __ INT __的内容。医生。

Answer 1

您可以修改 pdoc的html html template 为了。以下是自定义module.html.jinja2的一些示例：

__ __ INT __ INT __：

{% extends "default/module.html.jinja2" %}
{% macro docstring(var) %}
    {% if var.name != "__init__" %}
        {{ default_docstring(var) }}
    {% endif %}
{% endmacro %}

hide class-level docstrings：hide __ INT __ INT __ INT __ INT __ INT __

{% extends "default/module.html.jinja2" %}
{% macro docstring(var) %}
    {% if var.type != "class" %}
        {{ default_docstring(var) }}
    {% endif %}
{% endmacro %}

完全：完全：

{% extends "default/module.html.jinja2" %}
{% macro is_public(doc) %}
    {% if doc.name != "__init__" %}
        {{ default_is_public(doc) }}
    {% endif %}
{% endmacro %}