improve code docs

include/db/mysql.inc.php

@@ -43,7 +43,7 @@ function serendipity_db_in_sql($col, &$search_ids, $type = ' OR ') {
  *
  * This function returns values dependin on the input parameters and the result of the query.
  * It can return:
- *   false if there was an error,
+ *   false or a string if there was an error (depends on $expectError),
  *   true if the query succeeded but did not generate any rows
  *   array of field values if it returned a single row and $single is true
  *   array of array of field values if it returned row(s) [stacked array]

include/db/mysqli.inc.php

@@ -43,7 +43,7 @@ function serendipity_db_in_sql($col, &$search_ids, $type = ' OR ') {
  *
  * This function returns values dependin on the input parameters and the result of the query.
  * It can return:
- *   false if there was an error,
+ *   false or a string if there was an error (depends on $expectError),
  *   true if the query succeeded but did not generate any rows
  *   array of field values if it returned a single row and $single is true
  *   array of array of field values if it returned row(s) [stacked array]

include/db/pdo-postgres.inc.php

@@ -170,7 +170,7 @@ function serendipity_db_insert_id($table = '', $id = '') {
  *
  * This function returns values dependin on the input parameters and the result of the query.
  * It can return:
- *   false if there was an error,
+ *   false or a string if there was an error (depends on $expectError),
  *   true if the query succeeded but did not generate any rows
  *   array of field values if it returned a single row and $single is true
  *   array of array of field values if it returned row(s) [stacked array]

include/db/pdo-sqlite.inc.php

@@ -198,7 +198,7 @@ function serendipity_db_insert_id($table = '', $id = '') {
  *
  * This function returns values dependin on the input parameters and the result of the query.
  * It can return:
- *   false if there was an error,
+ *   false or a string if there was an error (depends on $expectError),
  *   true if the query succeeded but did not generate any rows
  *   array of field values if it returned a single row and $single is true
  *   array of array of field values if it returned row(s) [stacked array]

include/db/postgres.inc.php

@@ -176,7 +176,7 @@ function serendipity_db_insert_id($table = '', $id = '') {
  *
  * This function returns values dependin on the input parameters and the result of the query.
  * It can return:
- *   false if there was an error,
+ *   false or a string if there was an error (depends on $expectError),
  *   true if the query succeeded but did not generate any rows
  *   array of field values if it returned a single row and $single is true
  *   array of array of field values if it returned row(s) [stacked array]

include/db/sqlite.inc.php

@@ -194,7 +194,7 @@ function serendipity_db_in_sql($col, &$search_ids, $type = ' OR ') {
  *
  * This function returns values dependin on the input parameters and the result of the query.
  * It can return:
- *   false if there was an error,
+ *   false or a string if there was an error (depends on $expectError),
  *   true if the query succeeded but did not generate any rows
  *   array of field values if it returned a single row and $single is true
  *   array of array of field values if it returned row(s) [stacked array]

include/db/sqlite3.inc.php

@@ -202,7 +202,7 @@ function serendipity_db_in_sql($col, &$search_ids, $type = ' OR ') {
  *
  * This function returns values dependin on the input parameters and the result of the query.
  * It can return:
- *   false if there was an error,
+ *   false or a string if there was an error (depends on $expectError),
  *   true if the query succeeded but did not generate any rows
  *   array of field values if it returned a single row and $single is true
  *   array of array of field values if it returned row(s) [stacked array]

include/db/sqlrelay.inc.php

@@ -81,7 +81,7 @@ function serendipity_db_in_sql($col, &$search_ids, $type = ' OR ') {
  *
  * This function returns values dependin on the input parameters and the result of the query.
  * It can return:
- *   false if there was an error,
+ *   false or a string if there was an error (depends on $expectError),
  *   true if the query succeeded but did not generate any rows
  *   array of field values if it returned a single row and $single is true
  *   array of array of field values if it returned row(s) [stacked array]

include/plugin_api.inc.php

@@ -1504,7 +1504,7 @@ class serendipity_plugin
     function cleanup()
     {
         // Cleanup. Remove all empty configs on SAVECONF-Submit.
-        // serendipity_plugin_api::remove_plugin_value($this->instance, array('title', 'description'));
+        // serendipity_plugin_api::remove_plugin_value($this->instance, array('configname1', 'configname2'));
         return true;
     }