Github user zzcclp commented on a diff in the pull request:
https://github.com/apache/carbondata/pull/3030#discussion_r244495542
--- Diff: docs/csdk-guide.md ---
@@ -43,114 +43,116 @@ C++ SDK support read batch row. User can set batch by
using withBatch(int batch)
## API List
### CarbonReader
```
- /**
- * create a CarbonReaderBuilder object for building carbonReader,
- * CarbonReaderBuilder object can configure different parameter
- *
- * @param env JNIEnv
- * @param path data store path
- * @param tableName table name
- * @return CarbonReaderBuilder object
- */
- jobject builder(JNIEnv *env, char *path, char *tableName);
+/**
+ * create a CarbonReaderBuilder object for building carbonReader,
+ * CarbonReaderBuilder object can configure different parameter
+ *
+ * @param env JNIEnv
+ * @param path data store path
+ * @param tableName table name
+ * @return CarbonReaderBuilder object
+ */
+jobject builder(JNIEnv *env, char *path, char *tableName);
```
```
- /**
- * create a CarbonReaderBuilder object for building carbonReader,
- * CarbonReaderBuilder object can configure different parameter
- *
- * @param env JNIEnv
- * @param path data store path
- * */
- void builder(JNIEnv *env, char *path);
+/**
+ * create a CarbonReaderBuilder object for building carbonReader,
+ * CarbonReaderBuilder object can configure different parameter
+ *
+ * @param env JNIEnv
+ * @param path data store path
+ *
+ */
+void builder(JNIEnv *env, char *path);
```
```
- /**
- * Configure the projection column names of carbon reader
- *
- * @param argc argument counter
- * @param argv argument vector
- * @return CarbonReaderBuilder object
- */
- jobject projection(int argc, char *argv[]);
+/**
+ * Configure the projection column names of carbon reader
+ *
+ * @param argc argument counter
+ * @param argv argument vector
+ * @return CarbonReaderBuilder object
+ */
+jobject projection(int argc, char *argv[]);
```
```
- /**
- * build carbon reader with argument vector
- * it support multiple parameter
- * like: key=value
- * for example: fs.s3a.access.key=XXXX, XXXX is user's access key
value
- *
- * @param argc argument counter
- * @param argv argument vector
- * @return CarbonReaderBuilder object
- **/
- jobject withHadoopConf(int argc, char *argv[]);
+/**
+ * build carbon reader with argument vector
+ * it support multiple parameter
+ * like: key=value
+ * for example: fs.s3a.access.key=XXXX, XXXX is user's access key value
+ *
+ * @param argc argument counter
+ * @param argv argument vector
+ * @return CarbonReaderBuilder object
+ *
+ */
+jobject withHadoopConf(int argc, char *argv[]);
```
```
- /**
- * Sets the batch size of records to read
- *
- * @param batch batch size
- * @return CarbonReaderBuilder object
- */
- void withBatch(int batch);
+/**
+ * Sets the batch size of records to read
+ *
+ * @param batch batch size
+ * @return CarbonReaderBuilder object
+ */
+void withBatch(int batch);
```
```
- /**
- * Configure Row Record Reader for reading.
- */
- void withRowRecordReader();
+/**
+ * Configure Row Record Reader for reading.
+ */
+void withRowRecordReader();
```
```
- /**
- * build carbonReader object for reading data
- * it support read data from load disk
- *
- * @return carbonReader object
- */
- jobject build();
+/**
+ * build carbonReader object for reading data
+ * it support read data from load disk
--- End diff --
build to Build
recommend: it supports to read data from load disk
---
