From 73fd06fe7a5600dbc8339ac01acf49c66aef7e08 Mon Sep 17 00:00:00 2001 From: Andre Noll Date: Sat, 16 May 2020 13:03:51 +0200 Subject: [PATCH] Improve documentation of osl_rbtree_loop(). Mention that E_OSL_LOOP is the only possible error. Fix a few trivial whitespace issues and a typo while at it. --- osl.h.in | 8 +++----- 1 file changed, 3 insertions(+), 5 deletions(-) diff --git a/osl.h.in b/osl.h.in index 2abe135..3d21439 100644 --- a/osl.h.in +++ b/osl.h.in @@ -302,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. * @@ -324,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. */ @@ -347,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. */ @@ -408,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. * -- 2.39.2