X-Git-Url: http://git.tuebingen.mpg.de/?a=blobdiff_plain;f=osl.h.in;h=17bfbc16656abf7b6ac0a928378cc7529dbb00cf;hb=ec08b17c7514fe8c52d9bd8edf35460bc98a056e;hp=1e1ec965a719c73fc9d2e88e484fed47b19404c8;hpb=9c3878f15dd44c830acc22f661e8585a62adb5ed;p=osl.git diff --git a/osl.h.in b/osl.h.in index 1e1ec96..17bfbc1 100644 --- a/osl.h.in +++ b/osl.h.in @@ -62,7 +62,7 @@ enum osl_storage_flags { OSL_RBTREE = 1, /** The data for this column will have constant size. */ OSL_FIXED_SIZE = 2, - /** All values of this column will be different. */ + /** All values are different. Must be set if \p OSL_RBTREE is set. */ OSL_UNIQUE = 4, /** Do not free the data for this column (\p OSL_NO_STORAGE). */ OSL_DONT_FREE = 8 @@ -214,7 +214,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 */