未记录的功能不应在列表中查看/显示 - 仅针对已记录的实体发布文档
class EXAMPLE{
public func1()
private func2()
func3()
}
我只检查了有记录的实体。我有 func1 和 func3 的文档,但没有 func2 的文档。我有
EXTRACT_ALL = NO
EXTRACT_PRIVATE = NO
EXTRACT_STATIC = NO
EXTRACT_LOCAL_CLASSES = YES
EXTRACT_LOCAL_METHODS = NO
但是生成文档后我仍然看到 func2 的签名,没有超链接。
有谁知道一种方法来仅显示那些明确记录的功能?
class EXAMPLE{
public func1()
private func2()
func3()
}
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
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?
如果你对这篇内容有疑问,欢迎到本站社区发帖提问 参与讨论,获取更多帮助,或者扫码二维码加入 Web 技术交流群。
绑定邮箱获取回复消息
由于您还没有绑定你的真实邮箱,如果其他用户或者作者回复了您的评论,将不能在第一时间通知您!
发布评论
评论(2)
您必须打开 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.
的最终结果中包含记录的方法,
如果您只想在设置HIDE_UNDOC_MEMBERS = YES
还有一个隐藏未记录的类的标志: HIDE_UNDOC_CLASSES
if you only want to include documented methods in your final result that set
HIDE_UNDOC_MEMBERS = YES
there is also a flag to hide undocumented classes: HIDE_UNDOC_CLASSES