- docs extension: explain fetch_result functionality better to prevent errors

  because of wrong usage, found from Juha Heinanen


git-svn-id: https://openser.svn.sourceforge.net/svnroot/openser/trunk@5088 689a6050-402a-0410-94f2-e92a70836424

lib/srdb1/db.h

@@ -132,10 +132,15 @@ typedef int (*db_query_f) (const db_con_t* _h, const db_key_t* _k, const db_op_t
 				const db_key_t _o, db_res_t** _r);
 
 /**
- * \brief Fetch a number of rows from a result.
- * 
- * The function fetches a number of rows from a database result. If the number
- * of wanted rows is zero, the function returns anything with a result of zero.
+ * \brief Gets a partial result set, fetch rows from a result
+ *
+ * Gets a partial result set, fetch a number of rows from a database result.
+ * This function initialize the given result structure on the first run, and
+ * fetches the nrows number of rows. On subsequenting runs, it uses the
+ * existing result and fetches more rows, until it reaches the end of the
+ * result set. Because of this the result needs to be null in the first
+ * invocation of the function. If the number of wanted rows is zero, the
+ * function returns anything with a result of zero.
  * \param _h structure representing database connection
  * \param _r structure for the result
  * \param _n the number of rows that should be fetched