add missing doxygen docu

[libfirm] / include / libfirm / adt / obst.h

diff --git a/include/libfirm/adt/obst.h b/include/libfirm/adt/obst.h
index b49e36a..6198b8b 100644 (file)
--- a/include/libfirm/adt/obst.h
+++ b/include/libfirm/adt/obst.h
@@ -19,9 +19,8 @@
 
 /**
  * @file
- * @brief     Provied obstack_chunk_alloc and obstack_chunk_free for obstack.h
+ * @brief     Provides obstack_chunk_alloc and obstack_chunk_free for obstack.h
  * @author    Martin Trapp, Christian Schaefer
- * @version   $Id$
  */
 #ifndef FIRM_ADT_OBST_H
 #define FIRM_ADT_OBST_H
@@ -29,9 +28,13 @@
 #include "obstack.h"
 #include "xmalloc.h"
 
+/** @cond PRIVATE */
 #define obstack_chunk_alloc xmalloc
 #define obstack_chunk_free  free
+/** @endcond */
 
+/** An obstack initializer containing zero values. Can be used to initialize
+ * obstacks in an initializer. */
 #define NULL_OBST     { 0, NULL, NULL, NULL, NULL, 0, 0, NULL, NULL, NULL, 0, 0, 0 }
 
 #endif