added basic ssl support to ircu

[ircu2.10.12-pk.git] / include / dbuf.h

diff --git a/include/dbuf.h b/include/dbuf.h
index 97ce173d7aa5257a8950e5d19dcd0d35f0efe653..057ff2a6a691a6acb4560c5b66baa03f117dc04d 100644 (file)
--- a/include/dbuf.h
+++ b/include/dbuf.h
@@ -15,8 +15,10 @@
  * You should have received a copy of the GNU General Public License
  * along with this program; if not, write to the Free Software
  * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
- *
- * $Id$
+ */
+/** @file
+ * @brief Interfaces and declarations for dealing with data buffers.
+ * @version $Id$
  */
 #ifndef INCLUDED_dbuf_h
 #define INCLUDED_dbuf_h
@@ -28,26 +30,22 @@
 /*
  * These two globals should be considered read only
  */
-extern int DBufAllocCount;      /* GLOBAL - count of dbufs allocated */
-extern int DBufUsedCount;       /* GLOBAL - count of dbufs in use */
+extern int DBufAllocCount;
+extern int DBufUsedCount;
 
 struct DBufBuffer;
 
+/** Queue of data chunks. */
 struct DBuf {
-  unsigned int length;          /* Current number of bytes stored */
-  struct DBufBuffer *head;      /* First data buffer, if length > 0 */
-  struct DBufBuffer *tail;      /* last data buffer, if length > 0 */
+  unsigned int length;          /**< Current number of bytes stored */
+  struct DBufBuffer *head;      /**< First data buffer, if length > 0 */
+  struct DBufBuffer *tail;      /**< Last data buffer, if length > 0 */
 };
 
-/*
- * DBufLength - Returns the current number of bytes stored into the buffer.
- */
+/** Return number of bytes in a DBuf. */
 #define DBufLength(dyn) ((dyn)->length)
 
-/*
- * DBufClear - Scratch the current content of the buffer.
- * Release all allocated buffers and make it empty.
- */
+/** Release the entire content of a DBuf. */
 #define DBufClear(dyn) dbuf_delete((dyn), DBufLength(dyn))
 
 /*