X-Git-Url: http://git.tuebingen.mpg.de/?p=osl.git;a=blobdiff_plain;f=osl.h.in;h=d5a7d1d92330e02f9f2114a15eb48fdd57c04570;hp=67d705a5371a0f435297e9914e4efd8fd45d4072;hb=f0884471639e04bda513bb5a9055d5c00d8c4533;hpb=368cbd78587922ec3620b72bdb1c9f8cdf9297d1 diff --git a/osl.h.in b/osl.h.in index 67d705a..d5a7d1d 100644 --- a/osl.h.in +++ b/osl.h.in @@ -1,5 +1,5 @@ /* - * Copyright (C) 2007-2008 Andre Noll + * Copyright (C) 2007-2009 Andre Noll * * Licensed under the GPL v2. For licencing details see COPYING. */ @@ -7,6 +7,7 @@ /** \file osl.h User interface for the object storage layer. */ #include +#include /** Export all declarations in this file. */ #pragma GCC visibility push(default) @@ -77,7 +78,7 @@ struct osl_row; * specified. Such a function always takes pointers to the two objects to be * compared. It must return -1, zero, or 1, if the first argument is considered * to be respectively less than, equal to, or greater than the second. If two - * members compare as equal, their order in the sorted array is undefined. + * members compare as equal, their order in the rbtree is undefined. */ typedef int osl_compare_func(const struct osl_object *obj1, const struct osl_object *obj2); @@ -171,7 +172,7 @@ int osl_create_table(const struct osl_table_description *desc); * * Each osl table must be opened before its data can be accessed. * - * \param table_desc Describes the table to be opened. + * \param desc Describes the table to be opened. * \param result Contains a pointer to the open table on success. * * The table description given by \a desc should coincide with the @@ -220,7 +221,7 @@ int osl_get_row(const struct osl_table *t, unsigned col_num, * Retrieve an object identified by row and column * * \param t Pointer to an open osl table. - * \param r Pointer to the row. + * \param row Pointer to the row. * \param col_num The column number. * \param object The result pointer. * @@ -444,8 +445,8 @@ int osl_rbtree_last_row(const struct osl_table *t, unsigned col_num, * \param result Row is returned here. * * Retrieve the n-th order statistic with respect to the compare function - * of the rbtree column \a col_num. In other words, get that row with - * \a n th greatest value in column \a col_num. It's an error if + * of the rbtree column \a col_num. In other words, get the row with + * \a n th greatest value in column \a col_num. It is an error if * \a col_num is not a rbtree column, or if \a n is larger than the * number of rows in the table. * @@ -476,19 +477,6 @@ int osl_get_nth_row(const struct osl_table *t, unsigned col_num, int osl_get_rank(const struct osl_table *t, struct osl_row *r, unsigned col_num, unsigned *rank); -/** - * Compare two osl objects pointing to hash values. - * - * \param obj1 Pointer to the first hash object. - * \param obj2 Pointer to the second hash object. - * - * \return The values required for an osl compare function. - * - * \sa osl_compare_func, uint32_compare(). - */ -int osl_hash_compare(const struct osl_object *obj1, - const struct osl_object *obj2); - /** * Get a string describing the error code passed in the argument. *