Doxygen including methods twice doc files

Posted by Maarek on Stack Overflow See other posts from Stack Overflow or by Maarek
Published on 2010-06-13T22:28:36Z Indexed on 2010/06/13 22:32 UTC
Read the original article Hit count: 207

Filed under:
|

I'm having this issue where doxygen is adding the method twice in the documentation file. Is there a setting that stops auto-generation of documentation for methods within the .m file.

For example in the documentation I'll see something like whats below where the first definition of + (Status *)registerUser is from the header XXXXXX.h file where the second is from XXXXXX.m.

Header documentation :

/**
    @brief   Test
    Yada Yada
    @return     <#(description)#>
*/
+ (Status *)registerUser;

Output:

+ (Status *) registerUser               

Test Yada Yada.

Returns:
    <#(description)#> 

+ (Status *) registerUser               

<#(brief description)#> <#(comprehensive description)#>

registerUser

Returns:
    <#(description)#> 

Definition at line 24 of file XXXXXX.m.

Here are the build related configuration options. I've tried playing with them. EXTRACT_ALL with YES and NO... Hiding uncodumented Members and Classes.

#---------------------------------------------------------------------------
# Build related configuration options
#---------------------------------------------------------------------------
EXTRACT_ALL            = NO
EXTRACT_PRIVATE        = NO
EXTRACT_STATIC         = NO
EXTRACT_LOCAL_CLASSES  = YES
EXTRACT_LOCAL_METHODS  = NO
EXTRACT_ANON_NSPACES   = NO
HIDE_UNDOC_MEMBERS     = YES
HIDE_UNDOC_CLASSES     = YES
HIDE_FRIEND_COMPOUNDS  = NO
HIDE_IN_BODY_DOCS      = NO
INTERNAL_DOCS          = NO
CASE_SENSE_NAMES       = NO
HIDE_SCOPE_NAMES       = NO
SHOW_INCLUDE_FILES     = YES
FORCE_LOCAL_INCLUDES   = NO
INLINE_INFO            = YES
SORT_MEMBER_DOCS       = YES
SORT_BRIEF_DOCS        = NO
SORT_MEMBERS_CTORS_1ST = NO
SORT_GROUP_NAMES       = NO
SORT_BY_SCOPE_NAME     = NO

© Stack Overflow or respective owner

Related posts about objective-c

Related posts about doxygen