docs: 完善API文档注释

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

Author: CreaterOS

.DS_Store

@@ -7,12 +7,12 @@
 		<key>Paintinglite.xcscheme_^#shared#^_</key>
 		<dict>
 			<key>orderHint</key>
-			<integer>0</integer>
+			<integer>1</integer>
 		</dict>
 		<key>PaintingliteAggregate.xcscheme_^#shared#^_</key>
 		<dict>
 			<key>orderHint</key>
-			<integer>1</integer>
+			<integer>0</integer>
 		</dict>
 	</dict>
 </dict>

Paintinglite/.DS_Store

@@ -6,28 +6,41 @@
 //  Copyright © 2020 Bryant Reyn. All rights reserved.
 //
 
-/**
- * 智能查询操作
- * 针对多对象的查询分配操作
- * 支持操作
- * 1.基本查询 2.分页查询 3.排序查询 4.万能查询
+/*!
+ @header PaintingliteIntellegenceSelect
+ @abstract PaintingliteIntellegenceSelect 提供SDK框架中智能查询操作,针对多对象的查询分配操作[1.基本查询 2.分页查询 3.排序查询 4.万能查询]
+ @author CreaterOS
+ @version 1.00 2020/5/26 Creation (此文档的版本信息)
  */
 
 #import "PaintingliteTableOptions.h"
 
 NS_ASSUME_NONNULL_BEGIN
-
+/*!
+ @class PaintingliteIntellegenceSelect
+ @abstract PaintingliteIntellegenceSelect 提供SDK框架中智能查询操作,针对多对象的查询分配操作[1.基本查询 2.分页查询 3.排序查询 4.万能查询]
+ */
 @interface PaintingliteIntellegenceSelect : PaintingliteTableOptions
 
-/// 单例模式
+/*!
+ @method sharePaintingliteIntellegenceSelect
+ @abstract 单例模式生成PaintingliteIntellegenceSelect对象
+ @discussion 生成PaintingliteIntellegenceSelect在项目工程全局中只生成一个实例对象
+ @result PaintingliteIntellegenceSelect
+ */
 + (instancetype)sharePaintingliteIntellegenceSelect;
 
 #pragma mark - 智能查询操作
 
-/// 基本查询
-/// @param ppDb ppDb
-/// @param completeHandler 回调操作
-/// @param objects 可变参数,传入多个查询对象类型
+/*!
+ @method load: completeHandler: objects:
+ @abstract 基本查询
+ @discussion 基本查询,支持回调操作
+ @param ppDb Sqlite3 ppDb
+ @param objects 可变参数,传入多个查询对象类型
+ @param completeHandler 回调操作
+ @result Boolean
+ */
 - (Boolean)load:(sqlite3 *)ppDb completeHandler:(void(^ __nullable)(PaintingliteSessionError *error,Boolean success,NSMutableArray *loadArray))completeHandler objects:(id)objects,... NS_REQUIRES_NIL_TERMINATION;
 
 /* 分页查询 */

Paintinglite/Paintinglite.xcodeproj/project.xcworkspace/xcuserdata/niukouruanjian.xcuserdatad/UserInterfaceState.xcuserstate

@@ -6,15 +6,30 @@
 //  Copyright © 2020 Bryant Reyn. All rights reserved.
 //
 
+/*!
+ @header PaintingliteTableOptionsSelect
+ @abstract PaintingliteTableOptionsSelect 提供SDK框架中表操作
+ @author CreaterOS
+ @version 1.00 2020/6/1 Creation (此文档的版本信息)
+ */
+
 #import <Foundation/Foundation.h>
 #import "PaintingliteTableOptions.h"
 
 NS_ASSUME_NONNULL_BEGIN
-
+/*!
+ @class PaintingliteTableOptionsSelect
+ @abstract PaintingliteTableOptionsSelect 提供SDK框架中表操作
+ */
 @interface PaintingliteTableOptionsSelect : PaintingliteTableOptions
 
 
-/// 单例模式
+/*!
+ @method sharePaintingliteTableSelectOptions
+ @abstract 单例模式生成PaintingliteTableOptionsSelect对象
+ @discussion 生成PaintingliteTableOptionsSelect在项目工程全局中只生成一个实例对象
+ @result PaintingliteTableOptionsSelect
+ */
 + (instancetype)sharePaintingliteTableSelectOptions;
 
 

Paintinglite/Paintinglite.xcodeproj/xcuserdata/niukouruanjian.xcuserdatad/xcschemes/xcschememanagement.plist

@@ -6,25 +6,27 @@
 //  Copyright © 2020 Bryant Reyn. All rights reserved.
 //
 
-
-/**
- * 使用PQL语句进行快速查询
- * PQL语句默认全部查询
- * PQL语句类比SQL语句
- * 例: FROM user (基本语法是FROM + 类的对象)
- * 统一大写
- * 支持
- * 1.基本查询 2.条件查询 3.分页查询 4.排序查询 5.模糊查询
- * 直接封装到对象中
+/*!
+ @header PaintingliteTableOptionsSelectPQL
+ @abstract PaintingliteTableOptionsSelectPQL 提供SDK框架中PQL语句进行快速查询,PQL语句默认全部查询[FROM user (基本语法是FROM + 类的对象)](统一大写)[1.基本查询 2.条件查询 3.分页查询 4.排序查询 5.模糊查询],结果集直接封装到对象中
+ @author CreaterOS
+ @version 1.00 2020/5/26 Creation (此文档的版本信息)
  */
 
 #import "PaintingliteTableOptions.h"
 
 NS_ASSUME_NONNULL_BEGIN
-
+/*!
+ @class PaintingliteTableOptions
+ @abstract PaintingliteTableOptions 提供SDK框架中PQL语句进行快速查询,PQL语句默认全部查询[FROM user (基本语法是FROM + 类的对象)](统一大写)[1.基本查询 2.条件查询 3.分页查询 4.排序查询 5.模糊查询],结果集直接封装到对象中
+ */
 @interface PaintingliteTableOptionsSelectPQL : PaintingliteTableOptions
-
-/// 单例模式
+/*!
+ @method sharePaintingliteTableOptionsSelectPQL
+ @abstract 单例模式生成PaintingliteTableOptionsSelectPQL对象
+ @discussion 生成PaintingliteTableOptionsSelectPQL在项目工程全局中只生成一个实例对象
+ @result PaintingliteTableOptionsSelectPQL
+ */
 + (instancetype)sharePaintingliteTableOptionsSelectPQL;
 
 @end

Paintinglite/Paintinglite/Paintinglite/Opt/Data/PaintingliteIntellegenceSelect.h

@@ -8,7 +8,7 @@
 
 /*!
  @header PaintingliteSessionManager
- @abstract PaintingliteSessionManager提供SDK框架中所有的基本操作，开发这可以通过SessionManager获得数据库管理者，提供了大量的数据库操作方式
+ @abstract PaintingliteSessionManager 提供SDK框架中所有的基本操作，开发这可以通过SessionManager获得数据库管理者，提供了大量的数据库操作方式
  @author CreaterOS
  @version 1.00 2020/5/26 Creation (此文档的版本信息)
  */
@@ -23,7 +23,7 @@ NS_ASSUME_NONNULL_BEGIN
 
 /*!
  @class PaintingliteSessionManager
- @abstract PaintingliteSessionManager提供SDK框架中所有的基本操作，开发这可以通过SessionManager获得数据库管理者，提供了大量的数据库操作方式
+ @abstract PaintingliteSessionManager 提供SDK框架中所有的基本操作，开发这可以通过SessionManager获得数据库管理者，提供了大量的数据库操作方式
  */
 @interface PaintingliteSessionManager : NSObject
 /*!

Paintinglite/Paintinglite/Paintinglite/Opt/Data/PaintingliteTableOptionsSelect.h

@@ -6,19 +6,25 @@
 //  Copyright © 2020 Bryant Reyn. All rights reserved.
 //
 
-/**
- * PaintingliteBackUpManager
- * 用来备份,生成sql文件
- * 支持MySql ORCAL Sqlite SqlServer
- * 建库文件
- * 建表操作文件
- * 插入数据文件
+/*!
+ @header PaintingliteBackUpManager
+ @abstract PaintingliteBackUpManager 提供SDK框架中备份sql文件,支持备份类型MySql ORCAL Sqlite SqlServer
+ @author CreaterOS
+ @version 1.00 2020/6/6 Creation (此文档的版本信息)
  */
 
 #import <Foundation/Foundation.h>
 #import <Sqlite3.h>
 #import "PaintingliteSessionError.h"
 
+/*!
+ @abstract PaintingliteBackUpManagerDBType 备份类型
+ @constant PaintingliteBackUpSqlite3 Sqlite3
+ @constant PaintingliteBackUpMySql 删除表
+ @constant PaintingliteBackUpSqlServer SqlServer
+ @constant PaintingliteBackUpORCALE ORCALE
+ @discussion 备份类型
+*/
 typedef NS_ENUM(NSUInteger, PaintingliteBackUpManagerDBType) {
     PaintingliteBackUpSqlite3,
     PaintingliteBackUpMySql,
@@ -28,28 +34,49 @@ typedef NS_ENUM(NSUInteger, PaintingliteBackUpManagerDBType) {
 
 NS_ASSUME_NONNULL_BEGIN
 
+/*!
+ @class PaintingliteBackUpManager
+ @abstract PaintingliteBackUpManager 提供SDK框架中备份sql文件,支持备份类型MySql ORCAL Sqlite SqlServer
+ */
 @interface PaintingliteBackUpManager : NSObject
 
-/* 单例模式 */
+/*!
+ @method sharePaintingliteBackUpManager
+ @abstract 单例模式生成PaintingliteBackUpManager对象
+ @discussion 生成PaintingliteBackUpManager在项目工程全局中只生成一个实例对象
+ @result PaintingliteBackUpManager
+ */
 + (instancetype)sharePaintingliteBackUpManager;
 
-/**
- * 备份数据库
- * sqliteName -- 数据库名称
- * type -- 数据库类型
- * completeHandler -- 返回路径
+/*!
+ @method backupDataBaseWithName: sqliteName: type: completeHandler:
+ @abstract 备份数据库
+ @discussion 备份数据库,支持回调操作
+ @param sqliteName 数据库名称
+ @param type 数据库类型
+ @param completeHandler 返回路径
+ @result Boolean
  */
 - (Boolean)backupDataBaseWithName:(sqlite3 *)ppDb sqliteName:(NSString *)sqliteName type:(PaintingliteBackUpManagerDBType)type completeHandler:(void(^ __nullable)(NSString *saveFilePath))completeHandler;
 
-/**
- * 根据表名称数组备份
- * tableNameArray -- 表名数组
- * ppDb -- 数据库ppDb
+/*!
+ @method backupTableRowWithTableName: sqliteName: type: completeHandler:
+ @abstract 根据表名称数组备份
+ @discussion 根据表名称数组备份
+ @param tableNameArray 表名称数组
+ @param ppDb Sqlite3 ppDb
+ @result Boolean
  */
 - (Boolean)backupTableRowWithTableName:(NSMutableArray<NSString *> *__nonnull)tableNameArray ppDb:(sqlite3 *)ppDb;
 
-/**
- * 回退一次表数据
+/*!
+ @method backupTableValueForBeforeOpt:  tableName: completeHandler:
+ @abstract 回退一次表数据
+ @discussion 回退一次表数据,支持回调操作
+ @param ppDb Sqlite3 ppDb
+ @param tableName 表名称
+ @param completeHandler 回调操作
+ @result Boolean
  */
 - (Boolean)backupTableValueForBeforeOpt:(sqlite3 *)ppDb tableName:(NSString *__nonnull)tableName completeHandler:(void(^ __nullable)(PaintingliteSessionError *sessionerror,Boolean success, NSMutableArray<NSDictionary *> *newList))completeHandler;
 

Paintinglite/Paintinglite/Paintinglite/Opt/Data/PaintingliteTableOptionsSelectPQL.h

@@ -6,16 +6,20 @@
 //  Copyright © 2020 Bryant Reyn. All rights reserved.
 //
 
-/**
- * PaintingliteJSContext
- * 执行JavaScript脚本代码
- * JavaScript上下文
+/*!
+ @header PaintingliteJSContext
+ @abstract PaintingliteJSContext 提供SDK框架中执行JavaScript脚本代码
+ @author CreaterOS
+ @version 1.00 2020/7/29 Creation (此文档的版本信息)
  */
 
 #import <JavaScriptCore/JavaScriptCore.h>
 
 NS_ASSUME_NONNULL_BEGIN
-
+/*!
+ @class PaintingliteJSContext
+ @abstract PaintingliteJSContext 提供SDK框架中执行JavaScript脚本代码
+ */
 @interface PaintingliteJSContext : JSContext
 
 @end