projects
/
YACASL2.git
/ blobdiff
commit
grep
author
committer
pickaxe
?
search:
re
summary
|
shortlog
|
log
|
commit
|
commitdiff
|
tree
raw
|
inline
| side by side
Doxyfileのバージョンアップ
[YACASL2.git]
/
include
/
cerr.h
diff --git
a/include/cerr.h
b/include/cerr.h
index
5ff200c
..
9549de6
100644
(file)
--- a/
include/cerr.h
+++ b/
include/cerr.h
@@
-1,11
+1,16
@@
#ifndef YACASL2_CERR_H_INCLUDED
#define YACASL2_CERR_H_INCLUDED
#ifndef YACASL2_CERR_H_INCLUDED
#define YACASL2_CERR_H_INCLUDED
+#include <stdbool.h>
+#include <stdio.h>
+#include <stdlib.h>
+#include <string.h>
+#include <assert.h>
#include <stdbool.h>
#include "cmem.h"
/**
#include <stdbool.h>
#include "cmem.h"
/**
- *
エラーの構造体
+ *
@brief エラーを表すデータ型
*/
typedef struct _CERR {
int num; /**<エラー番号 */
*/
typedef struct _CERR {
int num; /**<エラー番号 */
@@
-13,12
+18,12
@@
typedef struct _CERR {
} CERR;
/**
} CERR;
/**
- * 現在のエラー
+ *
@brief
現在のエラー
*/
extern CERR *cerr;
/**
*/
extern CERR *cerr;
/**
- *
エラーリスト
型
+ *
@brief エラーリストのデータ
型
*/
typedef struct _CERRLIST {
struct _CERRLIST *next; /**<リスト次項目へのポインタ */
*/
typedef struct _CERRLIST {
struct _CERRLIST *next; /**<リスト次項目へのポインタ */
@@
-26,7
+31,7
@@
typedef struct _CERRLIST {
} CERRLIST;
/**
} CERRLIST;
/**
- * エラーリスト
+ *
@brief
エラーリスト
*/
extern CERRLIST *cerrlist;
*/
extern CERRLIST *cerrlist;
@@
-36,32
+41,52
@@
enum {
};
/**
};
/**
- * エラーの初期化
+ * @brief エラーを初期化する
+ *
+ * @return なし
*/
void cerr_init();
/**
*/
void cerr_init();
/**
- * エラーリストを作成・追加する
+ * @brief エラーリストを作成・追加する
+ *
+ * @return なし
+ *
+ * @param cerrc 作成または追加するエラーの数
+ * @param cerrv 作成または追加するエラーの配列
*/
void addcerrlist(int cerrc, CERR cerrv[]);
/**
*/
void addcerrlist(int cerrc, CERR cerrv[]);
/**
- * エラーリストを表示する
+ * @brief エラーリストを表示する
+ *
+ * @return なし
*/
void printcerrlist();
/**
*/
void printcerrlist();
/**
- * 現在のエラーを設定する
+ * @brief 現在のエラーを設定する
+ *
+ * @return なし
+ *
+ * @param num エラー番号
+ * @param *str エラーメッセージに含まれる文字列
*/
void setcerr(int num, const char *str);
/**
*/
void setcerr(int num, const char *str);
/**
- * エラーリストから、エラー番号に対応するメッセージを返す
+ * @brief エラー番号に対応するエラーメッセージを返す
+ *
+ * @return エラーメッセージ
+ *
+ * @param num エラー番号
*/
char *getcerrmsg(int num);
/**
*/
char *getcerrmsg(int num);
/**
- * エラーリストと現在のエラーを解放する
+ * @brief エラーリストと現在のエラーを解放する
+ *
+ * @return なし
*/
void freecerr();
#endif
*/
void freecerr();
#endif