Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
xianjimli committed Dec 21, 2018
1 parent 25afd23 commit 8d873ec
Show file tree
Hide file tree
Showing 119 changed files with 8,740 additions and 1,114 deletions.
28 changes: 24 additions & 4 deletions docs/manual/app_bar_t.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
## app\_bar\_t
### 概述
app_bar。一个简单的容器控件,一般在窗口的顶部。
它本身不提供布局功能(可用layout参数指定),和view功能一致,仅提供具有语义的标签,让xml更具有可读性。
![image](images/app_bar_t_0.png)

app_bar。一个简单的容器控件,一般在窗口的顶部。
它本身不提供布局功能(可用layout参数指定),和view功能一致,仅提供具有语义的标签,让xml更具有可读性。
### 函数
<p id="app_bar_t_methods">

Expand All @@ -22,17 +22,35 @@
| 事件名称 | 类型 | 说明 |
| -------- | ----- | ------- |
#### app\_bar\_cast 函数
* 函数原型:

```
widget_t* app_bar_cast (widget_t* widget);
```

* 参数说明:

-----------------------

| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | widget\_t* | app\_bar对象。 |
| widget | widget\_t* | app\_bar对象。 |
<p id="app_bar_t_app_bar_cast"> 转换为app_bar对象(供脚本语言使用)。
* 函数功能:

> <p id="app_bar_t_app_bar_cast"> 转换为app_bar对象(供脚本语言使用)。


#### app\_bar\_create 函数
* 函数原型:

```
widget_t* app_bar_create (widget_t* parent, xy_t x, xy_t y, wh_t w, wh_t h);
```

* 参数说明:

-----------------------

| 参数 | 类型 | 说明 |
Expand All @@ -43,7 +61,9 @@
| y | xy\_t | y坐标 |
| w | wh\_t | 宽度 |
| h | wh\_t | 高度 |
<p id="app_bar_t_app_bar_create"> 创建app_bar对象
* 函数功能:

> <p id="app_bar_t_app_bar_create"> 创建app_bar对象


Expand Down
126 changes: 113 additions & 13 deletions docs/manual/array_t.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,42 +31,80 @@
| 事件名称 | 类型 | 说明 |
| -------- | ----- | ------- |
#### array\_create 函数
* 函数原型:

```
array_t* array_create (uint16_t* capacity);
```

* 参数说明:

-----------------------

| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | array\_t* | 数组对象。 |
| capacity | uint16\_t* | 数组的初始容量。 |
<p id="array_t_array_create"> 创建array对象
* 函数功能:

> <p id="array_t_array_create"> 创建array对象



#### array\_deinit 函数
* 函数原型:

```
void array_deinit (array_t* array);
```

* 参数说明:

-----------------------

| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | void | 无。 |
| array | array\_t* | 数组对象。 |
<p id="array_t_array_deinit"> 清除数组中的元素。
* 函数功能:

> <p id="array_t_array_deinit"> 清除数组中的元素。



#### array\_destroy 函数
* 函数原型:

```
void array_destroy (array_t* array);
```

* 参数说明:

-----------------------

| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | void | 无。 |
| array | array\_t* | 数组对象。 |
<p id="array_t_array_destroy"> 清除数组中的元素,并释放数组对象。
* 函数功能:

> <p id="array_t_array_destroy"> 清除数组中的元素,并释放数组对象。



#### array\_find 函数
* 函数原型:

```
void* array_find (array_t* array, tk_compare_t cmp, void* ctx);
```

* 参数说明:

-----------------------

| 参数 | 类型 | 说明 |
Expand All @@ -75,12 +113,22 @@
| array | array\_t* | 数组对象。 |
| cmp | tk\_compare\_t | 比较函数,为NULL时直接比较指针。 |
| ctx | void* | 比较函数的上下文。 |
<p id="array_t_array_find"> 查找第一个满足条件的元素。
* 函数功能:

> <p id="array_t_array_find"> 查找第一个满足条件的元素。



#### array\_find\_index 函数
* 函数原型:

```
int array_find_index (array_t* array, tk_compare_t cmp, void* ctx);
```

* 参数说明:

-----------------------

| 参数 | 类型 | 说明 |
Expand All @@ -89,50 +137,90 @@
| array | array\_t* | 数组对象。 |
| cmp | tk\_compare\_t | 比较函数,为NULL时直接比较指针。 |
| ctx | void* | 比较函数的上下文。 |
<p id="array_t_array_find_index"> 查找第一个满足条件的元素,并返回位置。
* 函数功能:

> <p id="array_t_array_find_index"> 查找第一个满足条件的元素,并返回位置。



#### array\_init 函数
* 函数原型:

```
array_t* array_init (array_t* array, uint16_t* capacity);
```

* 参数说明:

-----------------------

| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | array\_t* | 数组对象。 |
| array | array\_t* | 数组对象。 |
| capacity | uint16\_t* | 数组的初始容量。 |
<p id="array_t_array_init"> 初始化array对象
* 函数功能:

> <p id="array_t_array_init"> 初始化array对象



#### array\_pop 函数
* 函数原型:

```
void* array_pop (array_t* array);
```

* 参数说明:

-----------------------

| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | void* | 成功返回最后一个元素,失败返回NULL。 |
| array | array\_t* | 数组对象。 |
<p id="array_t_array_pop"> 弹出最后一个元素。
* 函数功能:

> <p id="array_t_array_pop"> 弹出最后一个元素。



#### array\_push 函数
* 函数原型:

```
ret_t array_push (array_t* array, void* data);
```

* 参数说明:

-----------------------

| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | ret\_t | 返回RET\_OK表示成功,否则表示失败。 |
| array | array\_t* | 数组对象。 |
| data | void* | 待追加的元素。 |
<p id="array_t_array_push"> 在尾巴追加一个元素。
* 函数功能:

> <p id="array_t_array_push"> 在尾巴追加一个元素。



#### array\_remove 函数
* 函数原型:

```
ret_t array_remove (array_t* array, tk_compare_t cmp, void* ctx, tk_destroy_t destroy);
```

* 参数说明:

-----------------------

| 参数 | 类型 | 说明 |
Expand All @@ -142,12 +230,22 @@
| cmp | tk\_compare\_t | 比较函数,为NULL时直接比较指针。 |
| ctx | void* | 比较函数的上下文。 |
| destroy | tk\_destroy\_t | 销毁元素的回调函数。 |
<p id="array_t_array_remove"> 删除第一个满足条件的元素。
* 函数功能:

> <p id="array_t_array_remove"> 删除第一个满足条件的元素。



#### array\_remove\_all 函数
* 函数原型:

```
ret_t array_remove_all (array_t* array, tk_compare_t cmp, void* ctx, tk_destroy_t destroy);
```

* 参数说明:

-----------------------

| 参数 | 类型 | 说明 |
Expand All @@ -157,14 +255,16 @@
| cmp | tk\_compare\_t | 比较函数,为NULL时直接比较指针。 |
| ctx | void* | 比较函数的上下文。 |
| destroy | tk\_destroy\_t | 销毁元素的回调函数。 |
<p id="array_t_array_remove_all"> 删除全部满足条件的元素。
* 函数功能:

> <p id="array_t_array_remove_all"> 删除全部满足条件的元素。



#### capacity 属性
-----------------------
<p id="array_t_capacity"> 数组的容量大小。
> <p id="array_t_capacity"> 数组的容量大小。


Expand All @@ -182,7 +282,7 @@
| 支通过widget_set_prop修改 ||
#### elms 属性
-----------------------
<p id="array_t_elms"> 数组中的元素。
> <p id="array_t_elms"> 数组中的元素。


Expand All @@ -200,7 +300,7 @@
| 支通过widget_set_prop修改 ||
#### size 属性
-----------------------
<p id="array_t_size"> 数组中元素的个数。
> <p id="array_t_size"> 数组中元素的个数。


Expand Down
12 changes: 6 additions & 6 deletions docs/manual/asset_info_t.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@
| -------- | ----- | ------- |
#### is\_in\_rom 属性
-----------------------
<p id="asset_info_t_is_in_rom"> 资源是否在ROM中。
> <p id="asset_info_t_is_in_rom"> 资源是否在ROM中。


Expand All @@ -43,7 +43,7 @@
| 支通过widget_set_prop修改 ||
#### name 属性
-----------------------
<p id="asset_info_t_name"> 名称。
> <p id="asset_info_t_name"> 名称。


Expand All @@ -61,7 +61,7 @@
| 支通过widget_set_prop修改 ||
#### refcount 属性
-----------------------
<p id="asset_info_t_refcount"> 引用计数。is_in_rom == FALSE时才有效。
> <p id="asset_info_t_refcount"> 引用计数。is_in_rom == FALSE时才有效。


Expand All @@ -79,7 +79,7 @@
| 支通过widget_set_prop修改 ||
#### size 属性
-----------------------
<p id="asset_info_t_size"> 大小。
> <p id="asset_info_t_size"> 大小。


Expand All @@ -97,7 +97,7 @@
| 支通过widget_set_prop修改 ||
#### subtype 属性
-----------------------
<p id="asset_info_t_subtype"> 子类型。
> <p id="asset_info_t_subtype"> 子类型。


Expand All @@ -115,7 +115,7 @@
| 支通过widget_set_prop修改 ||
#### type 属性
-----------------------
<p id="asset_info_t_type"> 类型。
> <p id="asset_info_t_type"> 类型。


Expand Down
Loading

0 comments on commit 8d873ec

Please sign in to comment.