Inheritance Doxygen-从外部记录的抽象类继承文档 我正在编写我的C++类的文档,它继承了一个抽象类,其中文档已经通过标记文件外部提供。
我不想重写几个继承函数的文档,因为它只是抽象父函数的复制粘贴。但是,在Doxygen配置中指定我的标记文件并启用Inheritance Doxygen-从外部记录的抽象类继承文档 我正在编写我的C++类的文档,它继承了一个抽象类,其中文档已经通过标记文件外部提供。,inheritance,external,doxygen,Inheritance,External,Doxygen,我不想重写几个继承函数的文档,因为它只是抽象父函数的复制粘贴。但是,在Doxygen配置中指定我的标记文件并启用INHERIT_DOCS后,继承的文档仍然不存在 我是否缺少一些其他参数,或者这可能是强氧的限制 使用Doxygen直接处理父抽象类的头文件工作正常(文档包含在子类中)。此外,删除my child类中继承函数的声明将在“继承自ParentAbstractClass”组中添加该函数(但显然不再编译) 这是我的工作树: <root> +- ParentAbstractC
INHERIT_DOCS
后,继承的文档仍然不存在
我是否缺少一些其他参数,或者这可能是强氧的限制
使用Doxygen直接处理父抽象类的头文件工作正常(文档包含在子类中)。此外,删除my child类中继承函数的声明将在“继承自ParentAbstractClass
”组中添加该函数(但显然不再编译)
这是我的工作树:
<root>
+- ParentAbstractClass/
| +- html/
| |- ParentAbstractClass.tag
| |- ParentAbstractClass.hpp
+- ChildClass/
| +- html/
| |- ChildClass.hpp
|- Doxyfile_child
ChildClass.hpp的内容
#包括“ParentAbstractClass.hpp”
/**
*@简短儿童班
*/
类ChildClass:公共ParentAbstractClass
{
公众:
//以下函数应从其父函数继承文档
虚空继承函数(const int arg);
};
以及Doxyfile\u child
中的一些相关(我认为)选项:
OUTPUT_DIRECTORY = ChildClass
INHERIT_DOCS = YES
INLINE_INHERITED_MEMB = NO
TAGFILES = ParentAbstractClass/ParentAbstractClass.tag=../../ParentAbstractClass/html
我正在运行Doxygen 1.8.14。继承文档在一个项目中工作。
在标记文件(表示外部项目)中,没有关于“父”功能的信息。一旦您添加:
/// \copydoc ParentAbstractClass::inheritedFunction(const int arg)
作为ChildClass
中函数的文档,您将获得“Implements ParentAbstractClass.”以及ParentAbstractClass
中函数的函数引用 继承文档在一个项目中工作。
在标记文件(表示外部项目)中,没有关于“父”功能的信息。一旦您添加:
/// \copydoc ParentAbstractClass::inheritedFunction(const int arg)
作为ChildClass
中函数的文档,您将获得“Implements ParentAbstractClass.”以及ParentAbstractClass
中函数的函数引用 您使用的是哪个版本的doxygen?你能举一个小的完整例子吗?我使用的版本是1.814,并且刚刚用C++例证代码更新了这个问题。在标记文件(表示外部项目)中,没有关于“父”函数的信息。一旦您将//\copydoc ParentAbstractClass::inheritedFunction(const int arg)
作为文档添加到子类中的函数,您将获得“Implements ParentAbstractClass.”以及ParentAbstractClass中函数的引用。(还要注意,对标记文件的引用需要一个额外级别的。
,但这不是问题的原因)。这不完全是我想要的,因为我不想写任何东西并让doxygen“自动”链接到它,但正如您所指出的,这是不可能的。如果你把这个贴出来作为回答,我会接受的。(对于额外的。
,从根目录运行doxygen时不需要它们:doxygen-Doxyfile\u child
)您使用的是哪个版本的doxygen?你能举一个小的完整例子吗?我使用的版本是1.814,并且刚刚用C++例证代码更新了这个问题。在标记文件(表示外部项目)中,没有关于“父”函数的信息。一旦您将//\copydoc ParentAbstractClass::inheritedFunction(const int arg)
作为文档添加到子类中的函数,您将获得“Implements ParentAbstractClass.”以及ParentAbstractClass中函数的引用。(还要注意,对标记文件的引用需要一个额外级别的。
,但这不是问题的原因)。这不完全是我想要的,因为我不想写任何东西并让doxygen“自动”链接到它,但正如您所指出的,这是不可能的。如果你把这个贴出来作为回答,我会接受的。(对于额外的。
,从根目录运行doxygen时不需要它们:doxygen-Doxyfile\u子目录
)