Doxygen忽略一些.h文件

时间:2014-04-30 00:10:42

标签: xcode documentation doxygen

更新2:问题似乎源于文件本身,而不是内容。我尝试过多次回购,从头开始复制破碎的文件(新文件,复制粘贴内容,重命名等),它们按照预期的方式使用Doxygen。

更新:似乎所有的"破坏了#34;当.h文件是interface_.html时,.h文件被保存为class_.html。让我觉得相关。

尝试为我的Xcode项目设置Doxygen,由于某种原因,它忽略了我的一个回购中的.h文件。

该项目的基本结构是1个中央仓库,其中有少量私人CocoaPods从本地副本或外部仓库中提取,具体取决于哪个更新。其他pods项目,当针对Doxygen运行时,生成文档就好了。这个没有。我尝试过各种配置(EXTRACT_ALL,EXTRACT_STATIC等等)无济于事。

在以下.h文件上运行时,不会生成任何文档,我唯一看到的是"此类的文档是从以下文件生成的:",其中包含.m文件;单击它只显示一些静态字符串常量和导入,仍然没有方法标题。

我注意到的一件事是,如果我将EXTRACT_LOCAL_METHODS设置为YES然后它可以工作......但这意味着我没有在我的.h中定义方法,这绝对是不真实的。

我错过了什么吗?

#import <Foundation/Foundation.h>
#import <FinderAuthApiProtocol.h>
#import <AuthCredentials.h>

//Keys to name persisted objects
extern NSString *const kCarrierAuthCredentialsPersistName;
extern NSString *const kFinderAuthCredentialsPersistName;
extern NSString *const kLastLoggedInUserName;

@interface CommonAuthManager : NSObject
/**
 *  Returns the singleton object for CommonAuthManager, or creates one if necessary
 *
 *  @return pointer to the singleton instance
 */
+ (CommonAuthManager *)sharedInstance;

/**
 *  @brief Performs carrier-agnostic authenticaton
 *
 *  This method is called by the UI to perform authentication with a user's
 *    username and password combination.  The carrier-specific implementation of
 *    Network's FinderAuthApiProtocol determines the precise behavior but as far
 *    as the manager is concerned it doesn't matter; it just calls auth and waits
 *    for results
 *  
 *  @param userID - the user's ID (i.e. phone number, username, email, etc)
 *  @param password - the user's password
 *  @param stayLoggedIn - toggled value for refreshig auth tokens or not
 *  @param block - block for completion
 **/
+ (void)authWithUserID:(NSString *)userID
            andPassword:(NSString *)password
        andStayLoggedIn:(bool)stayLoggedIn
              withCompletionBlock:(void(^)(NSError *error))block;

/**
 *  Determines if current user is allowed to say logged in (bypass explicit login screen)
 *
 *  YES if all the following criteria are met:
 *    Current user must exist in persistence store
 *    Current user last login attempt must have succeeded
 *    Current user must be allowed to stay logged in
 *
 *  @param error return error
 *
 *  @return Returns YES if user is allowed to stay logged in
 */
+ (BOOL)isUserAllowedToStayLoggedIn:(NSError *__autoreleasing *)error;

/**
 *  Abstracted-away selector for the LLCommonAuthManager's finder API credentials
 **/
+ (AuthCredentials *)finderCredentials;

/**
 *  Abstracted-away selector for the LLCommonAuthManager's carrier API credentials
 *
 *  NOTE: Functionality across carriers varies.  For <XXX> this object will have
 *    the auth token, while for <YYY> it will be the username and password
 *    they originally authed with.
 **/
+ (AuthCredentials *)credentials;

@end

1 个答案:

答案 0 :(得分:0)

结果Doxygen需要文件底部的换行符。

谁知道。