• R/O
  • HTTP
  • SSH
  • HTTPS

hengband: Commit

変愚蛮怒のメインリポジトリです


Commit MetaInfo

Revisionfd6ea8b3e020f6e04220534897e6e0ce75cb7ddc (tree)
Time2014-06-28 20:45:54
AuthorDeskull <desull@user...>
CommiterDeskull

Log Message

japanese.cの関数にDoxygen用コメントを付与。

Change Summary

Incremental Difference

--- a/src/japanese.c
+++ b/src/japanese.c
@@ -53,7 +53,13 @@ static const convert_key s2j_table[] = {
5353 {NULL,NULL}
5454 };
5555
56-/* シンダリンを日本語の読みに変換する */
56+/*!
57+ * @brief シンダリンを日本語の読みに変換する
58+ * @param kana 変換後の日本語文字列ポインタ
59+ * @param sindarin 変換前のシンダリン文字列ポインタ
60+ * @return なし
61+ * @details
62+ */
5763 void sindarin_to_kana(char *kana, const char *sindarin)
5864 {
5965 char buf[256];
@@ -105,11 +111,10 @@ void sindarin_to_kana(char *kana, const char *sindarin)
105111 }
106112
107113
108-/*日本語動詞活用 (打つ>打って,打ち etc) */
109-/* JVERB_AND: 殴る,蹴る > 殴り,蹴る */
110-/* JVERB_TO: 殴る,蹴る > 殴って蹴る */
111-/* JVERB_OR: 殴る,蹴る > 殴ったり蹴ったり */
112-
114+/*! 日本語動詞活用 (打つ>打って,打ち etc)
115+ * JVERB_AND: 殴る,蹴る > 殴り,蹴る
116+ * JVERB_TO: 殴る,蹴る > 殴って蹴る
117+ * JVERB_OR: 殴る,蹴る > 殴ったり蹴ったり */
113118 static const struct jverb_table_t {
114119 const char* from;
115120 const char* to[3];
@@ -145,7 +150,15 @@ static const struct jverb_table_t {
145150 { NULL, {"そして", "ことにより", "ことや"}},
146151 };
147152
148-void jverb(const char *in , char *out , int flag)
153+/*!
154+ * @brief jverb_table_tに従って動詞を活用する
155+ * @param in 変換元文字列ポインタ
156+ * @param out 変換先文字列ポインタ
157+ * @param flag 変換種類を指定(JVERB_AND/JVERB_TO/JVERB_OR)
158+ * @return なし
159+ * @details
160+ */
161+void jverb(const char *in, char *out, int flag)
149162 {
150163 const struct jverb_table_t * p;
151164 int in_len = strlen(in);
@@ -164,9 +177,11 @@ void jverb(const char *in , char *out , int flag)
164177 strcpy(&out[in_len], p->to[flag - 1]);
165178 }
166179
167-
168-/*
169- * Convert SJIS string to EUC string
180+/*!
181+ * @brief 文字コードをSJISからEUCに変換する / Convert SJIS string to EUC string
182+ * @param str 変換する文字列のポインタ
183+ * @return なし
184+ * @details
170185 */
171186 void sjis2euc(char *str)
172187 {
@@ -208,8 +223,11 @@ void sjis2euc(char *str)
208223 }
209224
210225
211-/*
212- * Convert EUC string to SJIS string
226+/*!
227+ * @brief 文字コードをEUCからSJISに変換する / Convert EUC string to SJIS string
228+ * @param str 変換する文字列のポインタ
229+ * @return なし
230+ * @details
213231 */
214232 void euc2sjis(char *str)
215233 {
@@ -252,14 +270,14 @@ void euc2sjis(char *str)
252270 }
253271
254272
255-/*
256- * strを環境に合った文字コードに変換し、変換前の文字コードを返す。
257- * strの長さに制限はない。
258- *
259- * 0: Unknown
260- * 1: ASCII (Never known to be ASCII in this function.)
261- * 2: EUC
262- * 3: SJIS
273+/*!
274+ * @brief strを環境に合った文字コードに変換し、変換前の文字コードを返す。strの長さに制限はない。
275+ * @param str 変換する文字列のポインタ
276+ * @return
277+ * 0: Unknown<br>
278+ * 1: ASCII (Never known to be ASCII in this function.)<br>
279+ * 2: EUC<br>
280+ * 3: SJIS<br>
263281 */
264282 byte codeconv(char *str)
265283 {
@@ -343,7 +361,12 @@ byte codeconv(char *str)
343361 return code;
344362 }
345363
346-/* 文字列sのxバイト目が漢字の1バイト目かどうか判定する */
364+/*!
365+ * @brief 文字列sのxバイト目が漢字の1バイト目かどうか判定する
366+ * @param s 判定する文字列のポインタ
367+ * @param x 判定する位置(バイト)
368+ * @return 漢字の1バイト目ならばTRUE
369+ */
347370 bool iskanji2(cptr s, int x)
348371 {
349372 int i;
@@ -407,6 +430,11 @@ static const struct ms_to_jis_unicode_conv_t {
407430 {{0xef, 0xbc, 0x8d}, {0xe2, 0x88, 0x92}}, /* FULLWIDTH HYPHEN-MINUS -> MINUS SIGN */
408431 };
409432
433+/*!
434+ * @brief EUCがシステムコードである環境下向けにUTF-8から変換処理を行うサブルーチン
435+ * @param str 変換する文字列のポインタ
436+ * @return なし
437+ */
410438 static void ms_to_jis_unicode(char* str)
411439 {
412440 unsigned char* p;
Show on old repository browser