不记录的Doxygen - 函数不应在列表中显示/显示 - 仅针对记录的实体发布文档 [英] Doxygen - function not documented should not be viewable/displayed in the list - Issue document only for documented entities

查看:410
本文介绍了不记录的Doxygen - 函数不应在列表中显示/显示 - 仅针对记录的实体发布文档的处理方法,对大家解决问题具有一定的参考价值,需要的朋友们下面随着小编来一起学习吧!

问题描述

class EXAMPLE{
    public func1()
    private func2()
    func3()
}

我只检查了有记录的实体。我有func1和func3的文档,但没有func2的文档。我有

I have checked for documented entities only. I have documentation for func1 and func3 but no documentation for func2. I have

EXTRACT_ALL            = NO
EXTRACT_PRIVATE        = NO
EXTRACT_STATIC         = NO
EXTRACT_LOCAL_CLASSES  = YES
EXTRACT_LOCAL_METHODS  = NO

但在文档生成后,我仍然看到func2的签名

But after the documentation is generated I still see the signature of func2 without hyperlink.

有人知道只显示那些明确记载的函数的方法吗?

Does anyone know a way to show only those functions explicitly documented?

推荐答案

您必须打开EXTRACT_PRIVATE标志。
因为func2()是私有的,EXTRACT_PRIVATE标志指示Doxygen忽略私有,即使它们被记录。

You must turn on the EXTRACT_PRIVATE flag. As func2() is private and the EXTRACT_PRIVATE flag instructs Doxygen to ignore the private even if they are documented.

这篇关于不记录的Doxygen - 函数不应在列表中显示/显示 - 仅针对记录的实体发布文档的文章就介绍到这了,希望我们推荐的答案对大家有所帮助,也希望大家多多支持IT屋!

查看全文
登录 关闭
扫码关注1秒登录
发送“验证码”获取 | 15天全站免登陆