X-Git-Url: http://j8takagi.net/cgi-bin/gitweb.cgi?p=YACASL2.git;a=blobdiff_plain;f=include%2Fcerr.h;h=1433f9034f0886987796482769ab383e044ef861;hp=08532da410b825ad8ecdb01a441fab51c8eb2c1e;hb=7f7bde5dd1305cfc598fe09030c69aad0dc01368;hpb=3f7c17da3a4728cca94609014f6a29625eb1cb20 diff --git a/include/cerr.h b/include/cerr.h index 08532da..1433f90 100644 --- a/include/cerr.h +++ b/include/cerr.h @@ -1,48 +1,62 @@ #ifndef YACASL2_CERR_H_INCLUDED #define YACASL2_CERR_H_INCLUDED -#include -#include -#include -#include #include - #include "cmem.h" -/* エラーの構造体 */ +/** + * エラーの構造体 + */ typedef struct { - int num; /* エラー番号 */ - char *msg; /* エラーメッセージ */ + int num; /**<エラー番号 */ + char *msg; /**<エラーメッセージ */ } CERR; -/* 現在のエラー */ +/** + * 現在のエラー + */ extern CERR *cerr; -/* エラーリスト */ +/** + * エラーリスト型 + */ typedef struct _CERRLIST { - struct _CERRLIST *next; - CERR *cerr; + struct _CERRLIST *next; /**<リスト次項目へのポインタ */ + CERR *cerr; /**<エラーの構造体 */ } CERRLIST; +/** + * エラーリスト + */ extern CERRLIST *cerrlist; enum { - CERRSTRSIZE = 10, /* エラーメッセージ中に挿入できる文字列のサイズ */ - CERRMSGSIZE = 70, /* エラーメッセージのサイズ */ + CERRSTRSIZE = 10, /**<エラーメッセージ中に挿入できる文字列のサイズ */ + CERRMSGSIZE = 70, /**<エラーメッセージのサイズ */ }; -/* エラーの初期化 */ +/** + * エラーの初期化 + */ void cerr_init(); -/* エラーリストを作成・追加する */ +/** + * エラーリストを作成・追加する + */ bool addcerrlist(int cerrc, CERR cerrv[]); -/* エラー番号とエラーメッセージを設定 */ +/** + * 現在のエラーを設定する + */ void setcerr(int num, const char *str); -/* エラー番号からメッセージを返す */ +/** + * エラーリストから、エラー番号に対応するメッセージを返す + */ char *getcerrmsg(int num); -/* エラーを解放する */ +/** + * エラーリストと現在のエラーを解放する + */ void freecerr(); #endif