Skip to content

Commit 5cd3b46

Browse files
CreaterOSCreaterOS
committed
docs: Paintinglite API v1.0
完成Paintinglite API v1.0文档 # - type: feat(新特性), fix(修改问题), docs(文档修改), style(代码格式修改, 注意不是 css 修改), refactor(代码重构), test(测试), chore(其他修改, 比如构建流程, 依赖管理) # - scope: (可以为空) 影响的的范围 all ：表示影响面大 ，如修改了网络框架 会对真个程序产生影响 loation： 表示影响小，某个小小的功能 module：表示会影响某个模块 如登录模块、首页模块 、用户管理模块等等 # - subject 提交描述 # - body 具体的修改信息 应该尽量详细 # - footer 放置写备注啥的，如果是 bug ，可以把bug id放入
1 parent 08b4782 commit 5cd3b46

File tree

71 files changed

+6211
-499
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

71 files changed

+6211
-499
lines changed

‎.DS_Store

0 Bytes
Binary file not shown.

‎Paintinglite/Paintinglite.xcodeproj/project.xcworkspace/xcuserdata/bryantreyn.xcuserdatad/UserInterfaceState.xcuserstate

14.1 KB
Binary file not shown.

‎Paintinglite/Paintinglite.xcodeproj/xcuserdata/bryantreyn.xcuserdatad/xcschemes/xcschememanagement.plist

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,11 @@
55
<key>SchemeUserState</key>
66
<dict>
77
<key>Paintinglite.xcscheme_^#shared#^_</key>
8+
<dict>
9+
<key>orderHint</key>
10+
<integer>1</integer>
11+
</dict>
12+
<key>PaintingliteAggregate.xcscheme_^#shared#^_</key>
813
<dict>
914
<key>orderHint</key>
1015
<integer>0</integer>

‎Paintinglite/Paintinglite/Paintinglite/Opt/Data/PaintingliteAggregateFunc.h

Lines changed: 120 additions & 63 deletions
Original file line numberDiff line numberDiff line change
@@ -6,11 +6,13 @@
66
// Copyright © 2020 Bryant Reyn. All rights reserved.
77
//
88

9-
/**
10-
* PaintingliteAggregateFunc
11-
* 聚合函数
12-
* 1.COUNT 2.MAX 3.MIN 4.SUM 5.AVG
9+
/*!
10+
@header PaintingliteAggregateFunc
11+
@abstract PaintingliteAggregateFunc 提供SDK框架中聚合函数操作[COUNT MAX MIN SUM AVG]
12+
@author CreaterOS
13+
@version 1.00 2020/6/8 Creation (此文档的版本信息)
1314
*/
15+
1416
#import "PaintingliteTableOptions.h"
1517
#import "PaintingliteSessionError.h"
1618

@@ -22,93 +24,148 @@ typedef NS_ENUM(NSUInteger, PaintingliteAggregateType) {
2224
};
2325

2426
NS_ASSUME_NONNULL_BEGIN
25-
27+
/*!
28+
@class PaintingliteAggregateFunc
29+
@abstract PaintingliteAggregateFunc 提供SDK框架中PQL语句进行聚合函数操作[COUNT MAX MIN SUM AVG]
30+
*/
2631
@interface PaintingliteAggregateFunc : PaintingliteTableOptions
2732

28-
/// 单例模式
33+
/*!
34+
@method sharePaintingliteAggregateFunc
35+
@abstract 单例模式生成PaintingliteAggregateFunc对象
36+
@discussion 生成PaintingliteAggregateFunc在项目工程全局中只生成一个实例对象
37+
@result PaintingliteAggregateFunc
38+
*/
2939
+ (instancetype)sharePaintingliteAggregateFunc;
3040

3141
#pragma mark - 统计聚合函数
3242

33-
/// 统计聚合函数
34-
/// @param ppDb ppDb
35-
/// @param tableName 表名
36-
/// @param completeHandler 回调操作
43+
/*!
44+
@method count: tableName: completeHandler:
45+
@abstract 统计聚合函数
46+
@discussion 统计聚合函数,支持回调操作
47+
@param ppDb Sqlite3 ppDb
48+
@param tableName 表名称
49+
@param completeHandler 回调操作
50+
@result Boolean
51+
*/
3752
- (Boolean)count:(sqlite3 *)ppDb tableName:(NSString *)tableName completeHandler:(void (^ __nullable)(PaintingliteSessionError *sessionerror, Boolean success, NSUInteger count))completeHandler;
3853

39-
/// 条件统计聚合函数
40-
/// @param ppDb ppDb
41-
/// @param tableName 表名
42-
/// @param condatation 条件
43-
/// @param completeHandler 回调操作
44-
- (Boolean)count:(sqlite3 *)ppDb tableName:(NSString *)tableName condatation:(NSString *__nonnull)condatation completeHandler:(void (^ __nullable)(PaintingliteSessionError *sessionerror, Boolean success, NSUInteger count))completeHandler;
54+
/*!
55+
@method count: tableName: condatation: completeHandler:
56+
@abstract 条件统计聚合函数
57+
@discussion 统计聚合函数,支持回调操作
58+
@param ppDb Sqlite3 ppDb
59+
@param tableName 表名称
60+
@param condatation 条件
61+
@param completeHandler 回调操作
62+
@result Boolean
63+
*/
64+
- (Boolean)count:(sqlite3 *)ppDb tableName:(NSString *)tableName condatation:(NSString *__nonnull)condatation completeHandler:(void (^ __nullable)(PaintingliteSessionError *sessionerror, Boolean success, NSUInteger count))completeHandler;
4565

4666
#pragma mark - 总和聚合函数
4767

48-
/// 总和聚合函数
49-
/// @param ppDb ppDb
50-
/// @param field 字段
51-
/// @param tableName 表名
52-
/// @param completeHandler 回调操作
68+
/*!
69+
@method sum: field: tableName: completeHandler:
70+
@abstract 总和聚合函数
71+
@discussion 总和聚合函数,支持回调操作
72+
@param ppDb Sqlite3 ppDb
73+
@param field 字段
74+
@param tableName 表名称
75+
@param completeHandler 回调操作
76+
@result Boolean
77+
*/
5378
- (Boolean)sum:(sqlite3 *)ppDb field:(NSString *__nonnull)field tableName:(NSString *__nonnull)tableName completeHandler:(void (^ __nullable)(PaintingliteSessionError *sessionerror, Boolean success, double sum))completeHandler;
5479

55-
/// 条件总和聚合函数
56-
/// @param ppDb ppDb
57-
/// @param field 字段
58-
/// @param tableName 表名
59-
/// @param condatation 条件
60-
/// @param completeHandler 回调操作
80+
/*!
81+
@method sum: field: tableName: condatation: completeHandler:
82+
@abstract 总和聚合函数
83+
@discussion 总和聚合函数,支持回调操作
84+
@param ppDb Sqlite3 ppDb
85+
@param field 字段
86+
@param tableName 表名称
87+
@param condatation 条件
88+
@param completeHandler 回调操作
89+
@result Boolean
90+
*/
6191
- (Boolean)sum:(sqlite3 *)ppDb field:(NSString *__nonnull)field tableName:(NSString *__nonnull)tableName condatation:(NSString *__nonnull)condatation completeHandler:(void (^ __nullable)(PaintingliteSessionError *sessionerror, Boolean success, double sum))completeHandler;
6292

6393
#pragma mark - 最大值聚合函数
64-
65-
/// 最大值聚合函数
66-
/// @param ppDb ppDb
67-
/// @param field 字段
68-
/// @param tableName 表名
69-
/// @param completeHandler 回调操作
94+
/*!
95+
@method max: field: tableName: completeHandler:
96+
@abstract 最大值聚合函数
97+
@discussion 最大值聚合函数,支持回调操作
98+
@param ppDb Sqlite3 ppDb
99+
@param field 字段
100+
@param tableName 表名称
101+
@param completeHandler 回调操作
102+
@result Boolean
103+
*/
70104
- (Boolean)max:(sqlite3 *)ppDb field:(NSString *__nonnull)field tableName:(NSString *__nonnull)tableName completeHandler:(void (^ __nullable)(PaintingliteSessionError *sessionerror, Boolean success, double max))completeHandler;
71105

72-
/// 条件最大值聚合函数
73-
/// @param ppDb ppDb
74-
/// @param field 字段
75-
/// @param tableName 表名
76-
/// @param condatation 条件
77-
/// @param completeHandler 回调操作
106+
/*!
107+
@method max: field: tableName: condatation: completeHandler:
108+
@abstract 条件最大值聚合函数
109+
@discussion 条件最大值聚合函数,支持回调操作
110+
@param ppDb Sqlite3 ppDb
111+
@param field 字段
112+
@param tableName 表名称
113+
@param condatation 条件
114+
@param completeHandler 回调操作
115+
@result Boolean
116+
*/
78117
- (Boolean)max:(sqlite3 *)ppDb field:(NSString *__nonnull)field tableName:(NSString *__nonnull)tableName condatation:(NSString *__nonnull)condatation completeHandler:(void (^ __nullable)(PaintingliteSessionError *sessionerror, Boolean success, double max))completeHandler;
79118

80119
#pragma mark - 最小值聚合函数
81-
82-
/// 最小值聚合函数
83-
/// @param ppDb ppDb
84-
/// @param field 字段
85-
/// @param tableName 表名
86-
/// @param completeHandler 回调操作
120+
/*!
121+
@method min: field: tableName: completeHandler:
122+
@abstract 最小值聚合函数
123+
@discussion 条件最小值聚合函数,支持回调操作
124+
@param ppDb Sqlite3 ppDb
125+
@param field 字段
126+
@param tableName 表名称
127+
@param completeHandler 回调操作
128+
@result Boolean
129+
*/
87130
- (Boolean)min:(sqlite3 *)ppDb field:(NSString *__nonnull)field tableName:(NSString *__nonnull)tableName completeHandler:(void (^ __nullable)(PaintingliteSessionError *sessionerror, Boolean success, double min))completeHandler;
88131

89-
/// 条件最小值聚合函数
90-
/// @param ppDb ppDb
91-
/// @param field 字段
92-
/// @param tableName 表名
93-
/// @param condatation 条件
94-
/// @param completeHandler 回调操作
132+
/*!
133+
@method min: field: tableName: condatation: completeHandler:
134+
@abstract 条件最小值聚合函数
135+
@discussion 条件最小值聚合函数,支持回调操作
136+
@param ppDb Sqlite3 ppDb
137+
@param field 字段
138+
@param tableName 表名称
139+
@param condatation 条件
140+
@param completeHandler 回调操作
141+
@result Boolean
142+
*/
95143
- (Boolean)min:(sqlite3 *)ppDb field:(NSString *__nonnull)field tableName:(NSString *__nonnull)tableName condatation:(NSString *__nonnull)condatation completeHandler:(void (^ __nullable)(PaintingliteSessionError *sessionerror, Boolean success, double min))completeHandler;
96144

97145
#pragma mark - 平均值聚合函数
98-
99-
/// 平均值聚合函数
100-
/// @param ppDb ppDb
101-
/// @param field 字段
102-
/// @param tableName 表名
103-
/// @param completeHandler 回调操作
146+
/*!
147+
@method avg: field: tableName: completeHandler:
148+
@abstract 平均值聚合函数
149+
@discussion 平均值聚合函数,支持回调操作
150+
@param ppDb Sqlite3 ppDb
151+
@param field 字段
152+
@param tableName 表名称
153+
@param completeHandler 回调操作
154+
@result Boolean
155+
*/
104156
- (Boolean)avg:(sqlite3 *)ppDb field:(NSString *__nonnull)field tableName:(NSString *__nonnull)tableName completeHandler:(void (^ __nullable)(PaintingliteSessionError *sessionerror, Boolean success, double avg))completeHandler;
105157

106-
/// 条件平均值聚合函数
107-
/// @param ppDb ppDb
108-
/// @param field 字段
109-
/// @param tableName 表名
110-
/// @param condatation 条件
111-
/// @param completeHandler 回调操作
158+
/*!
159+
@method avg: field: tableName: condatation: completeHandler:
160+
@abstract 条件平均值聚合函数
161+
@discussion 条件平均值聚合函数,支持回调操作
162+
@param ppDb Sqlite3 ppDb
163+
@param field 字段
164+
@param tableName 表名称
165+
@param condatation 条件
166+
@param completeHandler 回调操作
167+
@result Boolean
168+
*/
112169
- (Boolean)avg:(sqlite3 *)ppDb field:(NSString *__nonnull)field tableName:(NSString *__nonnull)tableName condatation:(NSString *__nonnull)condatation completeHandler:(void (^ __nullable)(PaintingliteSessionError *sessionerror, Boolean success, double avg))completeHandler;
113170

114171

‎Paintinglite/Paintinglite/Paintinglite/Opt/Data/PaintingliteCUDOptions.h

Lines changed: 25 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -6,28 +6,40 @@
66
// Copyright © 2020 Bryant Reyn. All rights reserved.
77
//
88

9-
/**
10-
* PaintingliteCUDOptions
11-
* 表的增删改
12-
* 增加: 基本SQL执行增加 对象封装增加
13-
* 删除: 基本SQL执行删除 对象封装删除
14-
* 更新: 基本SQL执行更新 对象封装更新
9+
/*!
10+
@header PaintingliteCUDOptions
11+
@abstract PaintingliteCUDOptions 提供SDK框架中表的增删改
12+
@author CreaterOS
13+
@version 1.00 2020/6/4 Creation (此文档的版本信息)
1514
*/
1615

1716
#import "PaintingliteTableOptions.h"
1817

1918
NS_ASSUME_NONNULL_BEGIN
20-
19+
/*!
20+
@class PaintingliteCUDOptions
21+
@abstract PaintingliteCUDOptions 提供SDK框架中表的增删改
22+
*/
2123
@interface PaintingliteCUDOptions : PaintingliteTableOptions
2224

23-
/// 单例模式
25+
/*!
26+
@method sharePaintingliteCUDOptions
27+
@abstract 单例模式生成PaintingliteCUDOptions对象
28+
@discussion 生成PaintingliteCUDOptions在项目工程全局中只生成一个实例对象
29+
@result PaintingliteCUDOptions
30+
*/
2431
+ (instancetype)sharePaintingliteCUDOptions;
2532

26-
/// CUD操作
27-
/// @param ppDb ppDb
28-
/// @param sql CUD sql语句
29-
/// @param CUDHandler CUD回调操作
30-
/// @param completeHandler 回调操作
33+
/*!
34+
@method baseCUD: sql: CUDHandler: completeHandler:
35+
@abstract 增改删[CUD]操作
36+
@discussion 增改删[CUD]操作,支持回调操作
37+
@param ppDb Sqlite3 ppDb
38+
@param sql 增改删[CUD] sql语句
39+
@param CUDHandler 增改删[CUD] 回调操作
40+
@param completeHandler 回调操作
41+
@result Boolean
42+
*/
3143
- (Boolean)baseCUD:(sqlite3 *)ppDb sql:(NSString *)sql CUDHandler:(NSString *(^)(void))CUDHandler completeHandler:(void (^)(PaintingliteSessionError *sessionerror, Boolean success))completeHandler;
3244

3345
@end

‎Paintinglite/Paintinglite/Paintinglite/Opt/Data/PaintingliteCascadeShowerIUD.h

Lines changed: 44 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -6,29 +6,64 @@
66
// Copyright © 2020 Bryant Reyn. All rights reserved.
77
//
88

9-
/**
10-
* PaintingliteCascadeShowerIUD
11-
* 实现多表插入,多表更新,多表删除的级联操作
12-
* 对象用数组存储联动的另一个对象，从而达到级联操作
9+
/*!
10+
@header PaintingliteCascadeShowerIUD
11+
@abstract PaintingliteCascadeShowerIUD 实现多表插入,多表更新,多表删除的级联操作,对象用数组存储联动的另一个对象，从而达到级联操作
12+
@author CreaterOS
13+
@version 1.00 2020/6/8 Creation (此文档的版本信息)
1314
*/
1415

1516
#import "PaintingliteCUDOptions.h"
1617
#import "PaintingliteSessionError.h"
1718

1819
NS_ASSUME_NONNULL_BEGIN
19-
20+
/*!
21+
@class PaintingliteCascadeShowerIUD
22+
@abstract PaintingliteCascadeShowerIUD 提供SDK框架中表的增删改
23+
*/
2024
@interface PaintingliteCascadeShowerIUD : PaintingliteCUDOptions
2125

22-
/* 单例模式 */
26+
/*!
27+
@method sharePaintingliteCascadeShowerIUD
28+
@abstract 单例模式生成PaintingliteCascadeShowerIUD对象
29+
@discussion 生成PaintingliteCascadeShowerIUD在项目工程全局中只生成一个实例对象
30+
@result PaintingliteCascadeShowerIUD
31+
*/
2332
+ (instancetype)sharePaintingliteCascadeShowerIUD;
2433

25-
/* 级联插入 */
34+
/*!
35+
@method cascadeInsert: obj: completeHandler:
36+
@abstract 级联插入
37+
@discussion 级联插入,支持回调操作
38+
@param ppDb Sqlite3 ppDb
39+
@param obj 对象
40+
@param completeHandler 回调操作
41+
@result Boolean
42+
*/
2643
- (Boolean)cascadeInsert:(sqlite3 *)ppDb obj:(id)obj completeHandler:(void (^ __nullable)(PaintingliteSessionError *sessionError,Boolean success,NSMutableArray *resArray))completeHandler;
2744

28-
/* 级联更改 */
45+
/*!
46+
@method cascadeUpdate: obj: condatation: completeHandler:
47+
@abstract 级联更改
48+
@discussion 级联更改,支持回调操作
49+
@param ppDb Sqlite3 ppDb
50+
@param obj 对象
51+
@param condatation 更新条件
52+
@param completeHandler 回调操作
53+
@result Boolean
54+
*/
2955
- (Boolean)cascadeUpdate:(sqlite3 *)ppDb obj:(id)obj condatation:(NSArray<NSString *> * __nonnull)condatation completeHandler:(void (^__nullable)(PaintingliteSessionError *sessionError,Boolean success,NSMutableArray *resArray))completeHandler;
3056

31-
/* 级联删除 */
57+
/*!
58+
@method cascadeDelete: obj: condatation: completeHandler:
59+
@abstract 级联删除
60+
@discussion 级联删除,支持回调操作
61+
@param ppDb Sqlite3 ppDb
62+
@param obj 对象
63+
@param condatation 更新条件
64+
@param completeHandler 回调操作
65+
@result Boolean
66+
*/
3267
- (Boolean)cascadeDelete:(sqlite3 *)ppDb obj:(id)obj condatation:(NSArray<NSString *> * __nonnull)condatation completeHandler:(void (^__nullable)(PaintingliteSessionError *sessionError,Boolean success,NSMutableArray *resArray))completeHandler;
3368

3469
@end

0 commit comments

Comments
 (0)