From cb882d4351367ad2f644113d351fc5eb6ea12dd4 Mon Sep 17 00:00:00 2001 From: "Seungyoung \"Steve\" Kim" Date: Mon, 7 Nov 2016 22:02:14 -0800 Subject: [PATCH] Doc update & rebuild --- README.md | 2 +- doc/html/README_8md_source.html | 33 +++++++++++++++++---------------- doc/html/index.html | 3 ++- doc/html/qstring_8c.html | 12 ++++++------ doc/html/qstring_8c_source.html | 12 ++++++------ 5 files changed, 32 insertions(+), 30 deletions(-) diff --git a/README.md b/README.md index ddadf58c..e349eb2d 100644 --- a/README.md +++ b/README.md @@ -148,7 +148,7 @@ The following people have helped with suggestions, ideas, code or fixing bugs: * Maik Beckmann * RQ * [Ryan Gonzalez](https://github.com/kirbyfan64) -* [Seungyoung "Steve" Kim](https://github.com/wolkykim) - The Author +* [Seungyoung "Steve" Kim](https://github.com/wolkykim) - Project Lead * Umesh If we have forgotten or misspelled your name, please let us know. diff --git a/doc/html/README_8md_source.html b/doc/html/README_8md_source.html index 1834e058..d50c442a 100644 --- a/doc/html/README_8md_source.html +++ b/doc/html/README_8md_source.html @@ -202,22 +202,23 @@
135 
136 * [Alexandre Lucchesi](https://github.com/alexandrelucchesi)
137 * [Anthony Tseng](https://github.com/darkdh)
-
138 * Cesar
-
139 * [Colin](https://github.com/colintd)
-
140 * [Charles](https://github.com/Charles0429)
-
141 * [Dmitry Vorobiev](https://github.com/demitsuri)
-
142 * HyoSup Woo
-
143 * [Keith Rosenberg](https://github.com/netpoetica)
-
144 * Krishna
-
145 * [Liu Zhongchao](https://github.com/haveTryTwo)
-
146 * Luis Jimenez
-
147 * Maik Beckmann
-
148 * RQ
-
149 * [Ryan Gonzalez](https://github.com/kirbyfan64)
-
150 * [Seungyoung Kim](https://github.com/wolkykim)
-
151 * Umesh
-
152 
-
153 If we have forgotten or misspelled your name, please let us know.
+
138 * [Carpentier Pierre-Francois](https://github.com/kakwa)
+
139 * Cesar
+
140 * [Colin](https://github.com/colintd)
+
141 * [Charles](https://github.com/Charles0429)
+
142 * [Dmitry Vorobiev](https://github.com/demitsuri)
+
143 * HyoSup Woo
+
144 * [Keith Rosenberg](https://github.com/netpoetica)
+
145 * Krishna
+
146 * [Liu Zhongchao](https://github.com/haveTryTwo)
+
147 * Luis Jimenez
+
148 * Maik Beckmann
+
149 * RQ
+
150 * [Ryan Gonzalez](https://github.com/kirbyfan64)
+
151 * [Seungyoung "Steve" Kim](https://github.com/wolkykim) - Project Lead
+
152 * Umesh
+
153 
+
154 If we have forgotten or misspelled your name, please let us know.
qlisttbl
qlisttbl_t * qlisttbl(int options)
Create a new Q_LIST linked-list container.
Definition: qlisttbl.c:150
diff --git a/doc/html/index.html b/doc/html/index.html index 48484f10..9b17cfc8 100644 --- a/doc/html/index.html +++ b/doc/html/index.html @@ -185,6 +185,7 @@

Contributors

If we have forgotten or misspelled your name, please let us know.

diff --git a/doc/html/qstring_8c.html b/doc/html/qstring_8c.html index 4c47b6ab..c09ceb20 100644 --- a/doc/html/qstring_8c.html +++ b/doc/html/qstring_8c.html @@ -171,7 +171,7 @@ -
Returns
a pointer of source string if rsuccessful, otherewise returns NULL
+
Returns
a pointer of source string if successful, otherwise returns NULL
Note
This modify source string directly.

Definition at line 55 of file qstring.c.

@@ -199,7 +199,7 @@ -
Returns
a pointer of source string if rsuccessful, otherewise returns NULL
+
Returns
a pointer of source string if successful, otherwise returns NULL
Note
This modify source string directly.

Definition at line 90 of file qstring.c.

@@ -227,7 +227,7 @@ -
Returns
a pointer of source string if rsuccessful, otherewise returns NULL
+
Returns
a pointer of source string if successful, otherwise returns NULL
Note
This modify source string directly.

Definition at line 116 of file qstring.c.

@@ -273,7 +273,7 @@ -
Returns
a pointer of source string if successful, otherewise returns NULL
+
Returns
a pointer of source string if successful, otherwise returns NULL
Note
This modify source string directly.
char *str = strdup(" \"hello world\" ");
qstrtrim(str); // to remove white spaces
@@ -329,8 +329,8 @@ -
Returns
a pointer of malloced or source string depending on the mode if successful, otherewise returns NULL
-
Note
The mode argument has two separated character. First character is used to decide replacing method and can be 't' or 's'. The character 't' and 's' stand on [t]oken and [s]tring.
+
Returns
a pointer of malloced or source string depending on the mode if successful, otherwise returns NULL
+
Note
The mode argument has two separated characters. First character is used to decide replacing method and can be 't' or 's'. The character 't' and 's' stand on [t]oken and [s]tring.

When 't' is given each character of the token string(third argument) will be compared with source string individually. If matched one is found. the character will be replaced with given work.

If 's' is given instead of 't'. Token string will be analyzed only one chunk word. So the replacement will be occured when the case of whole word matched.

Second character is used to decide returning memory type and can be 'n' or 'r' which are stand on [n]ew and [r]eplace.

diff --git a/doc/html/qstring_8c_source.html b/doc/html/qstring_8c_source.html index 013ddea0..0a88cba6 100644 --- a/doc/html/qstring_8c_source.html +++ b/doc/html/qstring_8c_source.html @@ -115,7 +115,7 @@
48  *
49  * @param str source string
50  *
-
51  * @return a pointer of source string if rsuccessful, otherewise returns NULL
+
51  * @return a pointer of source string if successful, otherwise returns NULL
52  *
53  * @note This modify source string directly.
54  */
@@ -150,7 +150,7 @@
83  *
84  * @param str source string
85  *
-
86  * @return a pointer of source string if rsuccessful, otherewise returns NULL
+
86  * @return a pointer of source string if successful, otherwise returns NULL
87  *
88  * @note This modify source string directly.
89  */
@@ -176,7 +176,7 @@
109  *
110  * @param str source string
111  *
-
112  * @return a pointer of source string if rsuccessful, otherewise returns NULL
+
112  * @return a pointer of source string if successful, otherwise returns NULL
113  *
114  * @note This modify source string directly.
115  */
@@ -203,7 +203,7 @@
136  * @param head heading character
137  * @param tail tailing character
138  *
-
139  * @return a pointer of source string if successful, otherewise returns NULL
+
139  * @return a pointer of source string if successful, otherwise returns NULL
140  *
141  * @note This modify source string directly.
142  *
@@ -237,10 +237,10 @@
170  * @param word target word to be replaced
171  *
172  * @return a pointer of malloced or source string depending on the mode if
-
173  * successful, otherewise returns NULL
+
173  * successful, otherwise returns NULL
174  *
175  * @note
-
176  * The mode argument has two separated character. First character
+
176  * The mode argument has two separated characters. First character
177  * is used to decide replacing method and can be 't' or 's'.
178  * The character 't' and 's' stand on [t]oken and [s]tring.
179  *