awtk/docs/api_doc.md

注释格式

AWTK中的API注释，除了作为API的文档之外，还充当以下重要的作用：

• 提取JSON格式的IDL，用于生成各种语言的绑定代码。
• 用于设计器(designer)获取各个控件的元信息。

我采用了类似于jsduck的API注释格式，但是jsduck并不支持C语言的数据类型，所以没有办法完全兼容jsduck的格式。

一、类的注释

示例：

/**
 * @class progress_bar_t
 * @parent widget_t
 * @annotation ["scriptable"]
 * 进度条控件。
 */

里面说明了类的名称、基类的名称和该类型是否可以脚本化。对于类，annotation的取值有：

• scriptable 该类可以被脚本化。
• fake 该类是fake的，并不真实存在。

二、类成员变量注释

示例：

  /** 
   * @property {uint8_t} value
   * @annotation ["set_prop","get_prop","readable","persitent","design","scriptable"]
   * 进度条的值[0-100]。
   */

里面说明了成员变量的类型、名称和是否只读等信息。对于property，annotation的取值有：

• set_prop 是否可以通过widget_set_prop来设置该属性。
• get_prop 是否可以通过widget_get_prop来获取该属性。
• readable 该属性是否可以直接读取。
• writable 该属性是否可以直接修改。
• persitent 该属性是否需要持久化。
• design 该属性可以在设计器中设置。
• scriptable 该属性是否支持脚本化。

三、函数的注释

示例：

/**
 * @method progress_bar_create
 * @annotation ["constructor", "scriptable"]
 * 创建progress_bar对象
 * @param {widget_t*} parent 父控件
 * @param {xy_t} x x坐标
 * @param {xy_t} y y坐标
 * @param {wh_t} w 宽度
 * @param {wh_t} h 高度
 *
 * @return {widget_t*} 对象。
 */
widget_t* progress_bar_create(widget_t* parent, xy_t x, xy_t y, wh_t w, wh_t h); 

/**
 * @method progress_bar_cast
 * 转换为progress_bar对象(供脚本语言使用)。
 * @annotation ["cast", "scriptable"]
 * @param {widget_t*} widget progress_bar对象。
 *
 * @return {widget_t*} progress_bar对象。
 */
widget_t* progress_bar_cast(widget_t* widget);

/**
 * @method progress_bar_set_value
 * 设置进度条的进度。
 * @annotation ["scriptable"]
 * @param {widget_t*} widget 控件对象。
 * @param {uint8_t}  value 进度
 *
 * @return {ret_t} 返回RET_OK表示成功，否则表示失败。
 */
ret_t progress_bar_set_value(widget_t* widget, uint8_t value);

里面说明了函数的名称、参数和返回值。对于property，annotation的取值有：

• global 是否是全局函数。除了指明为全局函数，函数是当前类的成员函数。
• cast 类型转换函数。
• constructor 构造函数
• deconstructor 析构函数
• scriptable 是否可以脚本化。对于特殊函数(通常有回调函数作为参数)不方便直接产生代码，可以指定为scriptable:custom，使用定制的绑定代码。

四、枚举的注释

示例：

/**
 * @enum align_v_t
 * @annotation ["scriptable"]
 * 垂直对齐的常量定义。
 */
typedef enum _align_v_t {
  /**
   * @const ALIGN_V_NONE
   * 无效对齐方式。
   */
  ALIGN_V_NONE= 0,
  /**
   * @const ALIGN_V_MIDDLE
   * 居中对齐。
   */
  ALIGN_V_MIDDLE,
  /**
   * @const ALIGN_V_TOP
   * 顶部对齐。
   */
  ALIGN_V_TOP,
  /** 
   * @const ALIGN_V_BOTTOM
   * 底部对齐。
   */
  ALIGN_V_BOTTOM
}align_v_t;

里面定义了枚举的名称和各个枚举值。对于枚举，annotation的取值有：

• scriptable 该类可以被脚本化。