From e110cbf7293bd23e633f280296910bd4af1cec20 Mon Sep 17 00:00:00 2001 From: Andre Noll Date: Wed, 3 Jan 2018 02:45:15 +0100 Subject: [PATCH] Add explanation about lifetime of table description. --- osl.h.in | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/osl.h.in b/osl.h.in index 17bfbc1..2abe135 100644 --- 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 { /** -- 2.39.2