如何在appledoc / HeaderDoc中缩进文档(有关带参数的块的文档)

时间:2015-02-13 19:24:16

标签: ios objective-c swift appledoc headerdoc

我创建了一个以块作为参数的方法。这个块需要一些参数,所以我想像Apple那样在他们的方法中缩进类似格式的文档......

enter image description here

这在代码中的外观如下:

/** 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;

但显然这只会在文档中出现:

enter image description here

如何让datafields缩进,就像Apple的方法一样,带有参数的块?

我在Apple's documentation on HeaderDoc

中找不到如何执行此操作

1 个答案:

答案 0 :(得分:2)

您可以使用:

@param block My block with the following parameters: 
<table>
<tr>
  <td><tt>myParam</tt></td>
  <td>Description</td>
</tr>
</table>