docxgen生成接口文档的规范

/**

 @brief     用户登录接口

 @param username    用户名，当前为手机号

 @param type       登录类别，类型:enum TRLoginType

 @param callback    执行结束后的回调

 isSuc  YES 表示成功 NO
表示失败

 * * dic说明

 * * {

 * *  DICT_KEY_ERROR_CODE:#,   //对应的错误码 0
表示成功
其他表示失败

 * *  DICT_KEY_RETURN_CODE:#,  //对应的返回值 0
表示成功
其他表示失败

 * *  DICT_KEY_DESCRIPTION:#,  //返回描述信息

 * *  DICT_KEY_DATA:datadic    //仅在网络返回结果时有

 * *   {

 * *      user_exist_flag :#  1表示用户存在 0表示用户未注册

 * *   }

 * * }

 */

-(void)login:(NSString *)username type:(int)type

withCallback:(void (^)(BOOL isSuc,
NSDictionary * dic)) callback;

/**

 @brief     用户退出登录

 @param username    用户名，当前为手机号 eg :"+8615313883014"

 @param callback    
执行结束后的回调

 isSuc  YES 表示成功 NO
表示失败

 * * dic说明

 * * {

 * *  DICT_KEY_ERROR_CODE:#,   //对应的错误码 0
表示成功
其他表示失败

 * *  DICT_KEY_RETURN_CODE:#,  //对应的返回值 0
表示成功
其他表示失败

 * *  DICT_KEY_DESCRIPTION:#,  //返回描述信息

 * * }

 */

-(void)logout:(NSString *)username

 withCallback:(void (^)(BOOL isSuc,
NSDictionary * dic)) callback;

/**

 @brief     生成验证码

 *                  登录流程中，点击获取验证码时，向服务发起请求

 @param username    用户名，当前为手机号 eg :"+8615313883014"

 @param callback    
执行结束后的回调

 isSuc  YES 表示成功 NO
表示失败

 * * dic说明

 * * {

 * *  DICT_KEY_ERROR_CODE:#,   //对应的错误码 0
表示成功
其他表示失败

 * *  DICT_KEY_RETURN_CODE:#,  //对应的返回值 0
表示成功
其他表示失败

 * *  DICT_KEY_DESCRIPTION:#,  //返回描述信息

 * * }

 */

-(void)generateVerifyCode:(NSString *)username

             withCallback:(void (^)(BOOL isSuc,
NSDictionary * dic)) callback;