Inherits from UIViewController
Declared in MyDocViewController.h
MyDocViewController.m

Overview

主页面.

主页面的详细描述.

引用短代码, 如 someMethodByStr: .

示例代码:

int sum=0;
for(int i=1; i<=10; ++i) {
    sum += i;
}

无序列表:

  • abc
  • xyz
  • rgb

有序列表:

  1. first.
  2. second.
  3. third.

多级列表:

  • xyz
    • x
    • y
    • z
  • rgb
    • red
      1. first.
        1. alpha.
        2. beta.
      2. second.
      3. third.
    • green
    • blue

以下是仅doxygen可见内容. 因为appledoc不支持类型注释中的\@see标签(但支持在属性、方法中使用),会导致后续内容丢弃.

Tasks

Other Methods

Action Methods

Properties

alink

链接测试.

@property (nonatomic, strong) NSString *alink

Discussion

链接测试.

链接:

See Also

Declared In

MyDocViewController.h

alinklocal1

本地链接测试1 (仅appledoc).

@property (nonatomic, strong) NSString *alinklocal1

Discussion

本地链接测试1 (仅appledoc).

链接:

Declared In

MyDocViewController.h

alinklocal2

本地链接测试2 (仅appledoc).

@property (nonatomic, strong) NSString *alinklocal2

Discussion

本地链接测试2 (仅appledoc).

只要出现了 [ 类 成员 ] 形式的链接, 本地链接便会实效.

链接:

  • str : 自身属性.
  • someMethodByStr: : 自身方法.
  • MyDocViewController : 自身类. // appledoc无法识别.
  • MyDocAppDelegate : 外部类.
  • [MyDocViewController str] : 自身属性.

Declared In

MyDocViewController.h

alinklocal3

本地链接测试3 (仅appledoc).

@property (nonatomic, strong) NSString *alinklocal3

Discussion

本地链接测试3 (仅appledoc).

只要出现了 [ 类 成员 ] 形式的链接, 本地链接便会实效.

链接:

Declared In

MyDocViewController.h

delegate

委托.

@property (nonatomic, strong) id<MyDocDelegate> delegate

Discussion

委托.

Declared In

MyDocViewController.h

docTool

枚举的属性.

@property (nonatomic, assign) ObjCDocToolEnum docTool

Discussion

枚举的属性.

Declared In

MyDocViewController.h

floatByte

联合体的属性.

@property (nonatomic, assign) FloatByte floatByte

Discussion

联合体的属性.

Declared In

MyDocViewController.h

num

数值属性.

@property (nonatomic, assign) NSInteger num

Discussion

数值属性.

Declared In

MyDocViewController.h

prectInt

结构体常量指针的属性.

@property (nonatomic, assign) PCRectInt prectInt

Discussion

结构体常量指针的属性.

Declared In

MyDocViewController.h

rectInt

结构体的属性.

@property (nonatomic, assign) RectInt rectInt

Discussion

结构体的属性.

Declared In

MyDocViewController.h

str

字符串属性.

@property (nonatomic, strong) NSString *str

Discussion

字符串属性.

属性的详细描述.

Declared In

MyDocViewController.h

strend2

< 行尾注释1. appledoc不支持会变为下一项的注释, doxygen 支持, 根据英文句号自动切分详细描述与详细描述.

@property (nonatomic, strong) NSString *strend2

Discussion

< 行尾注释1. appledoc不支持会变为下一项的注释, doxygen 支持, 根据英文句号自动切分详细描述与详细描述.

Declared In

MyDocViewController.h

strend3

< 行尾注释2. appledoc不支持会变为下一项的注释, doxygen 支持, 会全部当作详细描述, 而缺少详细描述.

@property (nonatomic, strong) NSString *strend3

Discussion

< 行尾注释2. appledoc不支持会变为下一项的注释, doxygen 支持, 会全部当作详细描述, 而缺少详细描述.

Declared In

MyDocViewController.h

strend4

< 行尾注释3. appledoc不支持会变为下一项的注释, doxygen 支持.

@property (nonatomic, strong) NSString *strend4

Discussion

< 行尾注释3. appledoc不支持会变为下一项的注释, doxygen 支持.

Declared In

MyDocViewController.h

Class Methods

classInt

取得静态变量值的类方法.

+ (int)classInt

Return Value

返回_classInt静态变量的值.

Declared In

MyDocViewController.h

Instance Methods

callActionCallback:userdata:handler:

调用动作回调函数

- (void)callActionCallback:(void *)sender userdata:(void *)userdata handler:(ActionCallback)handler

Parameters

sender

发送者.

userdata

自定义数据.

handler

处理函数.

Declared In

MyDocViewController.h

callActionHandler:userdata:handler:

调用动作块函数.

- (void)callActionHandler:(id)sender userdata:(id)userdata handler:(ActionHandler)handler

Parameters

sender

发送者.

userdata

自定义数据.

handler

处理函数.

Declared In

MyDocViewController.h

someMethod

简单方法.

- (void)someMethod

Discussion

简单方法.

Declared In

MyDocViewController.h

someMethodByInt:

带整数参数的方法.

- (int)someMethodByInt:(int)value

Parameters

value

值.

Return Value

返回value.

Declared In

MyDocViewController.h

someMethodByStr:

带字符串参数的方法.

- (NSString *)someMethodByStr:(NSString *)value

Parameters

value

值.

Return Value

返回value.

Discussion

Warning: 警告: appledoc中显示为蓝色背景, Doxygen中显示为红色竖条.

Bug: 缺陷: appledoc中显示为黄色背景, Doxygen中显示为绿色竖条.

Exceptions

NSException

可能抛出的异常.

Declared In

MyDocViewController.h