Improve documentation of osl_rbtree_loop().

[osl.git] / osl.h.in

diff --git a/osl.h.in b/osl.h.in
index 5491a2c82411eb20a735185f6dd3b144cd00e881..3d21439719c3277bbd9d181d717cf82df7244e6b 100644 (file)
--- a/osl.h.in
+++ b/osl.h.in
@@ -124,6 +124,11 @@ struct osl_column_description {
 
 /**
  * Describes one osl table.
+ *
+ * A pointer to the table description is passed to \ref osl_create_table() and
+ * \ref osl_open_table(). The osl library calls which operate on an open table
+ * refer to the fields of the table description through this pointer. Hence the
+ * table description must not be modified or freed before the table is closed.
  */
 struct osl_table_description {
        /**
@@ -214,7 +219,8 @@ int osl_close_table(struct osl_table *t, enum osl_close_flags flags);
  * Lookup \a obj in \a t and return the row containing \a obj. The column
  * specified by \a col_num must have an associated rbtree.
  *
- * \return Standard.
+ * \return Standard. \a result is set to \p NULL if and only if the function
+ * returns negative.
  *
  * \sa osl_storage_flags
  */
@@ -296,7 +302,6 @@ int osl_close_disk_object(struct osl_object *obj);
 int osl_add_and_get_row(struct osl_table *t, struct osl_object *objects,
        struct osl_row **row);
 
-
 /**
  * Add a new row to an osl table.
  *
@@ -318,7 +323,7 @@ int osl_add_row(struct osl_table *t, struct osl_object *objects);
  * This removes all disk storage objects, removes all rbtree nodes,  and frees
  * all volatile objects belonging to the given row. For mapped columns, the
  * data is merely marked invalid and may be pruned from time to time by
- * osl_fsck.
+ * oslfsck.
  *
  * \return Standard.
  */
@@ -341,9 +346,9 @@ int osl_del_row(struct osl_table *t, struct osl_row *row);
  * second argument. The loop terminates either if \a func returns a negative
  * value, or if all nodes of the tree have been visited.
  *
- *
  * \return Standard. If the termination of the loop was caused by \a func
- * returning a negative value, \p -E_OSL_LOOP is returned.
+ * returning a negative value, \p -E_OSL_LOOP is returned. This is the only
+ * possible error.
  *
  * \sa osl_storage_flags, osl_rbtree_loop_reverse(), osl_compare_func.
  */
@@ -402,7 +407,6 @@ int osl_update_object(struct osl_table *t, const struct osl_row *r,
  */
 int osl_get_num_rows(const struct osl_table *t, unsigned *num_rows);
 
-
 /**
  * Get the row corresponding to the smallest rbtree node of a column.
  *