From: Thibaut VARÈNE <hacks@slashdirt.org>
Date: 2021年8月21日 14:17:39 +0000 (+0200)
Subject: doc
X-Git-Tag: v2.0~10
X-Git-Url: http://vcs.slashdirt.org/git/?a=commitdiff_plain;h=a426eeac72672a141078db23c54c31f9a1cb51f0;p=sw%2Ftic2json.git
doc
---
diff --git a/tic.c b/tic.c
index db7a295..3200bfd 100644
--- a/tic.c
+++ b/tic.c
@@ -6,6 +6,12 @@
 // License: GPLv2 - http://www.gnu.org/licenses/gpl-2.0.html
 //
 
+/**
+ * @file
+ * Common routines used by the TIC parsers.
+ * The code making use of the parsers must provide extra functions as mentioned in the header.
+ */
+
 #include <stdlib.h>
 #include <string.h>
 
diff --git a/tic.h b/tic.h
index 2c66d6b..b09a775 100644
--- a/tic.h
+++ b/tic.h
@@ -6,6 +6,15 @@
 // License: GPLv2 - http://www.gnu.org/licenses/gpl-2.0.html
 //
 
+/**
+ * @file
+ * Interface for TIC parsers
+ * Users of this interface must implement the functions listed at the bottom:
+ * - print_field()
+ * - frame_sep()
+ * - frame_err()
+ */
+
 #ifndef tic_h
 #define tic_h
 
@@ -19,7 +28,10 @@
 #define pr_err(format, ...) fprintf(stderr, "ERREUR: " format, ## __VA_ARGS__)
 #endif
 
-// The code assumes this fits on 4 bits
+/**
+ * TIC units.
+ * @warning The code assumes this fits on 4 bits
+ */
 enum tic_unit {
 	U_SANS = 0x00,
 	U_WH,
@@ -32,9 +44,12 @@ enum tic_unit {
 	U_MIN,
 };
 
-// this is to be packed in the upper 4 bits of a byte: must increment by 0x10
-// by default everything is an int
-enum data_type {
+/**
+ * TIC data types.
+ * By default everything is an int.
+ * @warning The code assumes this is packed in the upper 4 bits of a byte: must increment by 0x10.
+ */
+ enum data_type {
 	T_STRING = 0x10,
 	T_HEX = 0x20,
 };
@@ -59,8 +74,24 @@ void make_field(struct tic_field *field, const struct tic_etiquette *etiq, char
 void free_field(struct tic_field *field);
 
 // The following functions must be provided by the output interface
+
+/**
+ * Called for each valid dataset.
+ * Used to print a TIC dataset in the desired output format.
+ * @param field the dataset to print
+ */
 void print_field(const struct tic_field *field);
+
+/**
+ * Called after each frame, valid or not.
+ * Used to print a frame separator in the desired output format.
+ */
 void frame_sep(void);
+
+/**
+ * Called whenever a frame error condition occurs.
+ * When frames or datasets have errors.
+ */
 void frame_err(void);
 
 #endif /* tic_h */
</div><div class="naked_ctrl">
<form action="/index.cgi/larger-text" method="get" name="gate">
<p><a href="http://altstyle.alfasado.net">AltStyle</a> によって変換されたページ <a href="http://vcs.slashdirt.org/git/?a=commitdiff_plain&amp;h=a426eeac72672a141078db23c54c31f9a1cb51f0&amp;p=sw%2Ftic2json.git">(-&gt;オリジナル)</a>
/ <label>アドレス: <input type="text" name="naked_post_url" value="http://vcs.slashdirt.org/git/?a=commitdiff_plain&amp;h=a426eeac72672a141078db23c54c31f9a1cb51f0&amp;p=sw%2Ftic2json.git" size="22" /></label> <label>モード: <select name="naked_post_mode">
<option value="default">デフォルト</option>
<option value="speech">音声ブラウザ</option>
<option value="ruby">ルビ付き</option>
<option value="contrast">配色反転</option>
<option value="larger-text" selected="selected">文字拡大</option>
<option value="mobile">モバイル</option>
</select>
<input type="submit" value="表示" />
</p>
</form>
</div>