From: Andre Noll <maan@systemlinux.org>
Date: Mon, 11 Aug 2014 09:11:09 +0000 (+0200)
Subject: Improve documentation of the data_size field.
X-Git-Tag: v0.1.3~23
X-Git-Url: http://git.tuebingen.mpg.de/?p=osl.git;a=commitdiff_plain;h=aabf05500ba261ee978086094a69856eb2a0d3ef

Improve documentation of the data_size field.

Make it clear that for objects of type OSL_FIXED_SIZE, the size has
to be specified in number of bytes.
---

diff --git a/osl.h.in b/osl.h.in
index 388664e..26d02a4 100644
--- a/osl.h.in
+++ b/osl.h.in
@@ -116,7 +116,7 @@ struct osl_column_description {
 	osl_compare_func *compare_function;
 	/**
  	 * If the \a OSL_FIXED_SIZE flag is set for this column, this value
- 	 * determines the fixed size of all objects of this column. It is
+ 	 * describes the number of bytes of each object of this column. It is
  	 * ignored, if \a OSL_FIXED_SIZE is not set.
 	 */
 	uint32_t data_size;