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
/**
* 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 {
/**
* 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
*/