Add explanation about lifetime of table description.

[osl.git] / osl.h.in

diff --git a/osl.h.in b/osl.h.in
index 5491a2c82411eb20a735185f6dd3b144cd00e881..2abe135d7967446643aa6a803656aaa85b754d14 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
  */