Xcode 6中的Doxygen样式文档,链接到TypeDef文档

时间:2014-10-30 15:04:45

标签: xcode6 doxygen

我正在尝试正确记录我的自定义类。

我的类有自定义枚举和自定义函数。 我想要实现的是在自定义函数中,提供指向typedef枚举文档的链接,这样用户就可以直接看到枚举状态。

这是我所做的并且确实失败了:

/** @file AppSetingsManager */

///Enumerator states for Facebook Login
typedef enum {
    kFBUserLogedIn = 1, /**< Login from Facebook Finished */
    kFBUploadedData = 2, /** We have completed uploading user's data to our backend */
    kFBDidGetWritePermission = 3, /** We did obtain write permission from Facebook */
    KFBFinsishedWithExistingAccount = 4, /** Login completed, user had already an account on platform */
    KFBFinsishedWithNewAccount = 5 /**< Sign Up completed, a new user account was created */
} FaceBookLoginState;

/**
 * Performs login on Facebook with obj-c blocks
 *
 * @param dismissed The block to be executed after each step of the Login Process <b>Does return an FaceBookLoginState enumerator type of the login process stage</b>
 * @param cancelled The block to be executed in case the login process fails <b>Does return a String with the failure error</b>
 * @brief Facebook Login Function with blocks
 * @see AppSetingsManager#FaceBookLoginState
 */
- (void)loginFacebook:(DidFinishFBLogin)dismissed onCancel:(DidFailFBLogin)failed;

现在这在Xcode上看起来像这样:

Xcode documentation popup

正如您所看到的,它没有链接到枚举器状态文档。 我尝试了各种方法,如@see typedef ::FaceBookLoginState和其他方法,但似乎都没有。

任何人都知道是否可以这样做,如果是,怎么做?

0 个答案:

没有答案