首页
学习
活动
专区
圈层
工具
发布
社区首页 >问答首页 >如何对重载的类模板使用doxygenclass指令

如何对重载的类模板使用doxygenclass指令
EN

Stack Overflow用户
提问于 2021-11-30 16:26:44
回答 1查看 48关注 0票数 1

我有两个类模板,我需要使用Sphinx来记录它们。像往常一样,我对类使用了Doxygen样式的注释。但是,虽然我已经使用了doxygen directive,但我无法获得适当的文档。

Sample classes

代码语言:javascript
复制
namespace X
{
    /// Base Class
    /**
     * Description of Base Class
     * */
    class A
    {
        // Intentionally kept blank
    };


    /// Child Class First
    /**
     * Description of First Child Class
     * */
    template <typename T, int length_x>
    class B : public A
    {
        // Intentionally kept blank
    };


    /// Child Class Second
    /**
     * Description of Second Child Class
     * */
    template<typename T>
    class B<T, 1>  : public A
    {
        // Intentionally kept blank
    };
}

rst file的内容

代码语言:javascript
复制
.. _dummy class:

Dummy Class
===========

.. doxygenclass:: X::A
   :members:
   :protected-members:
   :private-members:

.. doxygenclass:: X::B
   :members:
   :protected-members:
   :private-members:

.. I know that the following will not work but given as my approach

.. doxygenclass:: X::B
   :members:
   :protected-members:
   :private-members:

我也通过查看this来尝试以下操作,但失败了。

代码语言:javascript
复制
.. _dummy class:

Dummy Class
===========

.. doxygenclass:: X::A
   :members:
   :protected-members:
   :private-members:

.. doxygenclass:: X::B
   :members:
   :protected-members:
   :private-members:

.. doxygenclass:: X::B<T, 1>
   :members:
   :protected-members:
   :private-members:

有没有办法用Sphinx记录这两个子类?

EN

回答 1

Stack Overflow用户

发布于 2021-12-01 11:21:55

最后,我得到了答案。这是一个写doxygendirective的打字错误

代码语言:javascript
复制
.. _dummy class:

Dummy Class
===========

.. doxygenclass:: X::A
   :members:
   :protected-members:
   :private-members:

.. doxygenclass:: X::B
   :members:
   :protected-members:
   :private-members:

.. doxygenclass:: X::B< T, 1 >
   :members:
   :protected-members:
   :private-members:

最重要的部分是这个.. doxygenclass:: X::B< T, 1 >。< >前后的空格。文档是here

票数 0
EN
页面原文内容由Stack Overflow提供。腾讯云小微IT领域专用引擎提供翻译支持
原文链接:

https://stackoverflow.com/questions/70172723

复制
相关文章

相似问题

领券
问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档