objcdoc
 全部  文件 函数 变量 类型定义 枚举 枚举值 属性 宏定义 
Instance Methods | Class Methods | Public 属性 | Protected 属性 | 属性 | 所有成员列表
MyDocViewController类 参考

主页面. 更多...

#import <MyDocViewController.h>

类 MyDocViewController 继承关系图:

Instance Methods

(void) - someMethod
 简单方法.
 
(int) - someMethodByInt:
 带整数参数的方法. 更多...
 
(NSString *) - someMethodByStr:
 带字符串参数的方法. 更多...
 
(void) - callActionCallback:userdata:handler:
 调用动作回调函数 更多...
 
(void) - callActionHandler:userdata:handler:
 调用动作块函数. 更多...
 

Class Methods

(int) + classInt
 取得静态变量值的类方法. 更多...
 

Public 属性

int _publicInt
 公开成员变量 (仅Doxygen, 会被归类为“Public 属性”).
 

Protected 属性

int _protectedInt
 protected成员变量 (仅Doxygen, 会被归类为“Protected 属性”).
 
id< MyDocDelegate_delegate
 委托变量.
 
package int _packageInt
 包内成员变量 (仅Doxygen, 会被归类为“Protected 属性”).
 

属性

NSInteger num
 数值属性.
 
NSString * str
 字符串属性. 更多...
 
NSString * strend1
 行尾注释1. 更多...
 
NSString * strend2
 
NSString * strend3
 行尾注释3. appledoc不支持会变为下一项的注释, doxygen 支持.
 
NSString * strend4
 行尾注释4. appledoc不支持会会忽略, doxygen 支持.
 
int dummy
 
ObjCDocToolEnum docTool
 枚举的属性.
 
RectInt rectInt
 结构体的属性.
 
PCRectInt prectInt
 结构体常量指针的属性.
 
FloatByte floatByte
 联合体的属性.
 
id< MyDocDelegatedelegate
 委托.
 
NSString * alink
 链接测试. 更多...
 
NSString * alinklocal1
 本地链接测试1 (仅appledoc). 更多...
 
NSString * alinklocal2
 本地链接测试2 (仅appledoc). 更多...
 
NSString * alinklocal3
 本地链接测试3 (仅appledoc). 更多...
 

详细描述

主页面.

主页面的详细描述.

引用短代码, 如 someMethodByStr: .

示例代码:

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

无序列表:

有序列表:

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

多级列表:

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

参见
str
- someMethodByStr: (MyDocViewController)
MyDocAppDelegate
[MyDocAppDelegate window] // 仅 appledoc. doxygen仅能识别出左边的类名.
[MyDocAppDelegate someMethodByFloat:] // 仅 appledoc. doxygen仅能识别出左边的类名.
MyDocAppDelegate.window // 仅 doxygen. appledoc仅能识别出左边的类名.
- someMethodByFloat: (MyDocAppDelegate) // 仅 doxygen. appledoc仅能识别出左边的类名.

end.

Method Documentation

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

调用动作回调函数

参数
sender发送者.
userdata自定义数据.
handler处理函数.
参见
- callActionHandler:userdata:handler: (MyDocViewController(Action))

Provided by category MyDocViewController(Action).

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

调用动作块函数.

参数
sender发送者.
userdata自定义数据.
handler处理函数.
参见
- callActionCallback:userdata:handler: (MyDocViewController(Action))

Provided by category MyDocViewController(Action).

+ (int) classInt

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

返回
返回_classInt静态变量的值.
- (int) someMethodByInt: (int)  value

带整数参数的方法.

参数
value值.
返回
返回value.
- (NSString *) someMethodByStr: (NSString*)  value

带字符串参数的方法.

参数
value值.
返回
返回value.
异常
NSException可能抛出的异常.
参见
- someMethod
- someMethodByInt:
警告
警告: appledoc中显示为蓝色背景, Doxygen中显示为红色竖条.
Bug:
缺陷: appledoc中显示为黄色背景, Doxygen中显示为绿色竖条.

属性说明

- (NSString*) alink
readwritenonatomicstrong

链接测试.

链接:

  • http://appledoc.gentlebytes.com/ : 直接写url链接.
  • Doxygen : 为链接提供文本 .
  • MyDocDelegate : 接口.
  • DocA : 类.
  • [文档B](DocB) : 类的链接文本.(仅appledoc)
  • 文档B : 为@ref链接提供文本 (仅doxygen. appledoc会把@ref当作文本而生成错误的链接).
  • DocB : @ref链接 (仅doxygen. appledoc会把@ref当作文本).
参见
str
- someMethodByStr:
MyDocAppDelegate
[MyDocAppDelegate window] // 仅 appledoc. doxygen仅能识别出左边的类名.
[MyDocAppDelegate someMethodByFloat:] // 仅 appledoc. doxygen仅能识别出左边的类名.
MyDocAppDelegate.window // 仅 doxygen. appledoc仅能识别出左边的类名.
- someMethodByFloat: (MyDocAppDelegate) // 仅 doxygen. appledoc仅能识别出左边的类名.
- (NSString*) alinklocal1
readwritenonatomicstrong

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

链接:

- (NSString*) alinklocal2
readwritenonatomicstrong

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

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

链接:

- (NSString*) alinklocal3
readwritenonatomicstrong

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

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

链接:

- (NSString*) str
readwritenonatomicstrong

字符串属性.

属性的详细描述.

- (NSString*) strend1
readwritenonatomicstrong

行尾注释1.

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

- (NSString*) strend2
readwritenonatomicstrong

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


该类的文档由以下文件生成: