#define YACASL2_CMEM_H_INCLUDED
#include <stdlib.h>
-/*
- * 配列のサイズを返す
+/**
+ * @brief 配列のサイズを返すマクロ
*/
#ifndef ARRAYSIZE
#define ARRAYSIZE(array) (sizeof(array)/sizeof(array[0]))
#endif
/**
- * メモリを解放
+ * @brief メモリを解放するマクロ
*/
#ifndef FREE
#define FREE(ptr) {free(ptr); ptr = NULL;}
#endif
/**
- * mallocを実行し、0で初期化
+ * @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);