projects
/
YACASL2.git
/ blobdiff
commit
grep
author
committer
pickaxe
?
search:
re
summary
|
shortlog
|
log
|
commit
|
commitdiff
|
tree
raw
|
inline
| side by side
Doxygenドキュメントの修正
[YACASL2.git]
/
include
/
word.h
diff --git
a/include/word.h
b/include/word.h
index
647f8a4
..
7215a54
100644
(file)
--- a/
include/word.h
+++ b/
include/word.h
@@
-3,31
+3,57
@@
#include <stdbool.h>
#include <stdbool.h>
-/* WORD - 16ビットデータ型 */
+/**
+ * @brief 16ビットの数値を表すデータ型
+ */
typedef unsigned short WORD;
/**
typedef unsigned short WORD;
/**
- * wordのエラーをエラーリストに追加
+ * @brief アセンブル結果読み込みエラーをエラーリストに追加する
+ */
+void addcerrlist_load();
+
+/**
+ * @brief wordデータ型についてのエラーをエラーリストに追加する
+ *
+ * @return なし
*/
void addcerrlist_word();
/**
*/
void addcerrlist_word();
/**
- * 10進数または16進数の文字列をWORD値に変換
+ * @brief 10進数または16進数の文字列をWORD値に変換する
+ *
+ * @return WORD値
+ *
+ * @param *str 10進数または16進数の文字列
*/
WORD nh2word(const char *str);
/**
*/
WORD nh2word(const char *str);
/**
- * WORD値を10進数の文字列に変換
+ * @brief WORD値を10進数値を表す文字列に変換する
+ *
+ * @return 10進数値を表す文字列
+ *
+ * @param *word WORD値
*/
char *word2n(WORD word);
/**
*/
char *word2n(WORD word);
/**
- * WORD値を2進数の文字列に変換
+ * @brief WORD値を2進数の文字列に変換する
+ *
+ * @return 2進数値を表す文字列
+ *
+ * @param word WORD値
*/
char *word2bit(const WORD word);
/**
*/
char *word2bit(const WORD word);
/**
- * WORD値を解析して表示
+ * @brief WORD値を解析して表示する
+ *
+ * @return なし
+ *
+ * @param word WORD値
+ * @param logicalmode 論理演算の場合はtrue、算術演算の場合はfalse
*/
void print_dumpword(WORD word, bool logicalmode);
*/
void print_dumpword(WORD word, bool logicalmode);