X-Git-Url: http://j8takagi.net/cgi-bin/gitweb.cgi?a=blobdiff_plain;f=include%2Fcmem.h;h=85cb7203e29b16c04a9559f5cace05e1cc227d3c;hb=d0124a6af0df0f5f6d5efc9bd5013ff0c3b626a1;hp=2e7cd3c1464f054e59fc82ecb675a874c697b856;hpb=555c5e8b851becc08ba661a9cb19f617d5a00c12;p=YACASL2.git

diff --git a/include/cmem.h b/include/cmem.h
index 2e7cd3c..85cb720 100644
--- a/include/cmem.h
+++ b/include/cmem.h
@@ -1,28 +1,54 @@
 #ifndef YACASL2_CMEM_H_INCLUDED
 #define YACASL2_CMEM_H_INCLUDED
-
-#include <stdio.h>
 #include <stdlib.h>
-#include <string.h>
-#include <assert.h>
-#include <stdbool.h>
 
+/**
+ * @brief 配列のサイズを返すマクロ
+ */
 #ifndef ARRAYSIZE
 #define ARRAYSIZE(array) (sizeof(array)/sizeof(array[0]))
 #endif
 
-/* mallocを実行し、メモリを確保できない場合は */
-/* エラーを出力して終了 */
+/**
+ * @brief メモリを解放するマクロ
+ */
+#ifndef FREE
+#define FREE(ptr) {free(ptr); ptr = NULL;}
+#endif
+
+/**
+ * @brief mallocを実行し、0で初期化する
+ *
+ * メモリを確保できない場合はエラーを出力して終了
+ *
+ * @return なし
+ *
+ * @param size メモリーのサイズ
+ * @param tag エラーメッセージなどで表示されるタグ
+ */
 void *malloc_chk(size_t size, char *tag);
 
-/* callocを実行し、メモリを確保できない場合は */
-/* エラーを出力して終了 */
+/**
+ * @brief 領域の数とサイズを指定してメモリーを確保するcallocを実行する
+ *
+ * メモリを確保できない場合はエラーを出力して終了
+ *
+ * @return なし
+ *
+ * @param nmemb 領域の数
+ * @param size 領域1個あたりのメモリーサイズ
+ * @param tag エラーメッセージなどで表示されるタグ
+ */
 void *calloc_chk(size_t nmemb, size_t size, char *tag);
 
-/* malloc_chkを実行してメモリを確保してから、 */
-/* コピーした文字列を返す */
+/**
+ * @brief malloc_chkを実行してメモリを確保し、コピーした文字列を返す
+ *
+ * @return コピーした文字列
+ *
+ * @param s 文字列
+ * @param tag エラーメッセージなどで表示されるタグ
+ */
 char *strdup_chk(const char *s, char *tag);
 
-/* メモリがNULLの場合は解放 */
-void free_chk(void *ptr, char *tag);
 #endif