Как документировать Objective-C блоки с doxygen?
Я работаю над проектом, основанным на доксигенной документации, и я не могу понять, как документировать блок. Представьте себе асинхронную функцию с блоком как обратный вызов
- (void)startWithCompletionBlock:(void (^)(BOOL success, NSError *error))block;
Как документировать этот параметр?
Ответы
Ответ 1
Как показано в документации комментарий блока будет выглядеть следующим образом
/**
*@brief Short description
*
* Extended description
*
*@param[in/out/in,out] success
*@param[in/out/in,out] error
*/
(void)startWithCompletionBlock:(void (^)(BOOL success, NSError *error))block;