【问题标题】:Doxygen - Objective-C - Document Private Class functions PrivateDoxygen - Objective-C - 文档私有类函数私有
【发布时间】:2009-06-25 00:47:51
【问题描述】:

在 doxygen 中,我可以在我的实现文件中创建 Objective-c 类别来隐藏不应公开访问的接口。但是,doxygen 仍然将该类别记录为“公共”成员。即使添加了\protected 或\private,情况仍然如此。

是否有另一种我忽略的方法可以将其放在该类别的“私有方法”部分......或者更好的是放在公共类仅列为私有的同一文档中?

这是我的配置的一部分:

#---------------------------------------------------------------------------
# Project related configuration options
#---------------------------------------------------------------------------
DOXYFILE_ENCODING      = UTF-8
PROJECT_NAME           = "My Project"
PROJECT_NUMBER         = 
OUTPUT_DIRECTORY       = /Users/theuser/Development/myApplication/Documentation
CREATE_SUBDIRS         = NO
OUTPUT_LANGUAGE        = English
BRIEF_MEMBER_DESC      = YES
REPEAT_BRIEF           = YES
ABBREVIATE_BRIEF       = 
ALWAYS_DETAILED_SEC    = NO
INLINE_INHERITED_MEMB  = NO
FULL_PATH_NAMES        = YES
STRIP_FROM_PATH        = 
STRIP_FROM_INC_PATH    = 
SHORT_NAMES            = NO
JAVADOC_AUTOBRIEF      = NO
QT_AUTOBRIEF           = NO
MULTILINE_CPP_IS_BRIEF = NO
INHERIT_DOCS           = YES
SEPARATE_MEMBER_PAGES  = NO
TAB_SIZE               = 8
ALIASES                = 
OPTIMIZE_OUTPUT_FOR_C  = NO
OPTIMIZE_OUTPUT_JAVA   = NO
OPTIMIZE_FOR_FORTRAN   = NO
OPTIMIZE_OUTPUT_VHDL   = NO
EXTENSION_MAPPING      = 
BUILTIN_STL_SUPPORT    = NO
CPP_CLI_SUPPORT        = NO
SIP_SUPPORT            = NO
IDL_PROPERTY_SUPPORT   = YES
DISTRIBUTE_GROUP_DOC   = NO
SUBGROUPING            = YES
TYPEDEF_HIDES_STRUCT   = YES
SYMBOL_CACHE_SIZE      = 0

#---------------------------------------------------------------------------
# Build related configuration options
#---------------------------------------------------------------------------
EXTRACT_ALL            = YES
EXTRACT_PRIVATE        = YES
EXTRACT_STATIC         = YES
EXTRACT_LOCAL_CLASSES  = YES
EXTRACT_LOCAL_METHODS  = NO
EXTRACT_ANON_NSPACES   = NO
HIDE_UNDOC_MEMBERS     = YES
HIDE_UNDOC_CLASSES     = YES
HIDE_FRIEND_COMPOUNDS  = YES
HIDE_IN_BODY_DOCS      = NO
INTERNAL_DOCS          = YES
CASE_SENSE_NAMES       = NO
HIDE_SCOPE_NAMES       = NO
SHOW_INCLUDE_FILES     = YES
INLINE_INFO            = YES
SORT_MEMBER_DOCS       = YES
SORT_BRIEF_DOCS        = YES
SORT_GROUP_NAMES       = NO
SORT_BY_SCOPE_NAME     = NO
GENERATE_TODOLIST      = YES
GENERATE_TESTLIST      = YES
GENERATE_BUGLIST       = YES
GENERATE_DEPRECATEDLIST= YES
ENABLED_SECTIONS       = 
MAX_INITIALIZER_LINES  = 30
SHOW_DIRECTORIES       = NO
SHOW_FILES             = YES
SHOW_NAMESPACES        = YES
FILE_VERSION_FILTER    = 
LAYOUT_FILE            = 

【问题讨论】:

    标签: objective-c class private doxygen


    【解决方案1】:

    您是否尝试过代码中的\internal,以及Doxyfile 中的INTERNAL_DOCS = NO

    另一种将部分代码置于 doxygen 范围之外的方法是使用 \cond\endcond 命令。

    【讨论】:

    • 是的,当我尝试时,该功能似乎仍然出现,但详细说明消失了。
    • 我将不得不尝试使用 \cond 和 \endcond。这听起来很有希望,因为它似乎只是 doxygen 忽略的东西。
    猜你喜欢
    • 2012-08-22
    • 2011-12-02
    • 2016-07-27
    • 2013-11-27
    • 2012-05-06
    • 1970-01-01
    • 2016-04-22
    • 1970-01-01
    • 2011-08-04
    相关资源
    最近更新 更多