我有两个类模板,我需要使用Sphinx来记录它们。像往常一样,我对类使用了Doxygen样式的注释。但是,虽然我已经使用了doxygen directive,但我无法获得适当的文档。
Sample classes
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的内容
.. _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来尝试以下操作,但失败了。
.. _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记录这两个子类?
发布于 2021-12-01 11:21:55
最后,我得到了答案。这是一个写doxygendirective的打字错误
.. _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。
https://stackoverflow.com/questions/70172723
复制相似问题