ir_visibility cleanup

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

diff --git a/include/libfirm/adt/xmalloc.h b/include/libfirm/adt/xmalloc.h
index 36ffd2a..b07d0b7 100644 (file)
--- a/include/libfirm/adt/xmalloc.h
+++ b/include/libfirm/adt/xmalloc.h
@@ -21,27 +21,51 @@
  * @file
  * @brief       never failing wrappers for malloc() & friends.
  * @author      Markus Armbruster
- * @version     $Id$
  * @note        The functions here never fail because they simply abort your
  *              program in case of an error.
  */
 #ifndef FIRM_ADT_XMALLOC_H
 #define FIRM_ADT_XMALLOC_H
 
-#ifdef __cplusplus
-extern "C" {
-#endif
-
 #include <stddef.h>
 #include <stdlib.h>
 #include <string.h>
 
-/* xmalloc() & friends. */
+/* Includes for alloca() */
+#ifdef _WIN32
+#include <malloc.h>
+#endif
+
+#include "../begin.h"
 
-void *xmalloc(size_t size);
-void *xrealloc(void *ptr, size_t size);
-char *xstrdup(const char *str);
+/**
+ * @ingroup adt
+ * @defgroup xmalloc Memory Allocation
+ * @{
+ */
 
+/**
+ * Allocate @p size bytes on the heap.
+ * This is a wrapper for malloc which calls panic() in case of errors, so no
+ * error handling is required for code using it.
+ */
+FIRM_API void *xmalloc(size_t size);
+/**
+ * Chane size of a previously allocated memory block to @p size bytes.
+ * This is a wrapper for realloc which calls panic() in case of errors, so no
+ * error handling is required for code using it.
+ */
+FIRM_API void *xrealloc(void *ptr, size_t size);
+/**
+ * Allocates memory and copies string @p str into it.
+ * This is a wrapper for strdup which calls panic() in case of errors, so no
+ * error handling is required for code using it.
+ */
+FIRM_API char *xstrdup(const char *str);
+/**
+ * Another name for the free function
+ * @deprecated
+ */
 #define xfree(ptr)      free(ptr)
 
 /**
@@ -122,17 +146,8 @@ char *xstrdup(const char *str);
  */
 #define OALLOCFZ(obst, type, member, n) ((type*)memset(OALLOCF((obst), type, member, (n)), 0, offsetof(type, member) + sizeof(*((type*)0)->member) * (n)))
 
+/** @} */
 
-/* Includes for alloca() */
-#ifdef _WIN32
-#include <malloc.h>
-#endif
-#ifdef HAVE_ALLOCA_H
-#include <alloca.h>
-#endif
-
-#ifdef __cplusplus
-}
-#endif
+#include "../end.h"
 
 #endif