Fix comments for some ODR members
[yaz-moved-to-github.git] / include / yaz / odr.h
index 9c4f658..9b70faf 100644 (file)
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 1995-2004, Index Data.
+ * Copyright (C) 1995-2005, Index Data ApS
  *
  * Permission to use, copy, modify, distribute, and sell this software and
  * its documentation, in whole or in part, for any purpose, is hereby granted,
  * LIABILITY, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE
  * OF THIS SOFTWARE.
  *
- * $Id: odr.h,v 1.16 2004-08-13 07:30:06 adam Exp $
+ * $Id: odr.h,v 1.19 2005-01-27 09:04:07 adam Exp $
+ */
+
+/**
+ * \file odr.h
+ * \brief Header for ODR (Open Data Representation)
  */
 
 #ifndef ODR_H
@@ -118,10 +123,10 @@ typedef struct odr
 
     int can_grow;         /* are we allowed to reallocate */
     unsigned char *buf;            /* memory handle */
-    int size;             /* current buffer size */
+    int size;             /* current buffer size (encoding+decoding) */
 
-    int pos;              /* current position */
-    int top;              /* top of buffer (max pos when decoding) */
+    int pos;              /* current position (encoding) */
+    int top;              /* top of buffer (max pos when encoding) */
 
     const unsigned char *bp; /* position in buffer (decoding) */