Как сделать отступ в документации в appledoc/HeaderDoc (для документации по блокам, которые принимают аргументы)
Я создал метод, который имеет блок в качестве параметра. Блок принимает некоторые аргументы, поэтому я хотел бы сделать отступ в документации, как это делает Apple в своих методах, имеющих похожий формат...
Простой пример того, как это будет выглядеть в коде:
/** Loads a project from web service.
@param securityKey The security key.
@param block The block to execute after the web service returned all data. The block takes five arguments:
@param data The data.
@param fields Some fields.
*/
- (void)loadProjectWithSecurityKey:(NSString *)securityKey andCompletion:(void(^)(NSDictionary *data, NSDictionary *fields))completion;
Но ясно, что это будет выглядеть только так в документации:
Как я могу получить data
а также fields
выглядеть с отступом как метод Apple, который принимает блок с аргументами?
Я не мог найти, как сделать это в документации Apple на HeaderDoc
1 ответ
Решение
Ты можешь использовать:
@param block My block with the following parameters:
<table>
<tr>
<td><tt>myParam</tt></td>
<td>Description</td>
</tr>
</table>