rb-grn-encoding.c in groonga-0.0.2

- old
+ new

@@ -20,11 +20,55 @@
 
 /*
  * Document-module: Groonga::Encoding
  *
  * groongaがサポートしてるエンコーディングが定義されてい
- * るモジュールです。
+ * るモジュール。
+ *
+ * エンコーディングの指定方法は以下の通り。
+ *
+ * [+nil+]
+ *   コンテキストと関連付けられているオブジェクトの場合（多
+ *   くの場合）はコンテキストのエンコーディングを使用。
+ *
+ *   それ以外のオブジェクトの場合（コンテキスト自身など）は
+ *   groongaのビルド時に指定したエンコーディング
+ *   （Groonga::Encoding::DEFAULT）を使用
+ *
+ * [+:default+]
+ *   groongaのビルド時に指定したエンコーディングを使用。
+ *   Groonga::Encoding::DEFAULT
+ *
+ * [+:none+]
+ *   エンコーディングを指定しない。Groonga::Encoding::NONE
+ *
+ * [+:euc_jp+]
+ *   EUC-JPを使用。Groonga::Encoding::EUC_JP
+ *
+ * [<tt>"euc-jp"</tt>]
+ *   +:euc_jp+と同じ。
+ *
+ * [+:utf8+]
+ *   UTF-8を使用。Groonga::Encoding::UTF8
+ *
+ * [<tt>"utf-8"</tt>]
+ *   +:utf8+と同じ。
+ *
+ * [+:sjis+]
+ *   Shift_JISを使用。Groonga::Encoding::SJIS
+ *
+ * [+:shift_jis+]
+ *   +:sjis+と同じ。
+ *
+ * [<tt>"shift-jis"</tt>]
+ *   +:sjis+と同じ。
+ *
+ * [+:latin1+]
+ *   Latin-1を使用。Groonga::Encoding::LATIN1
+ *
+ * [+:koi8r+]
+ *   KOI8-Rを使用。Groonga::Encoding::KOI8R
  */
 
 static VALUE mGrnEncoding;
 static VALUE RB_GRN_ENCODING_DEFAULT;
 static VALUE RB_GRN_ENCODING_NONE;
@@ -102,15 +146,28 @@
     }
 
     return rb_encoding;
 }
 
+/*
+ * call-seq:
+ *   Groonga::Encoding.default -> エンコーディング
+ *
+ * デフォルトのエンコーディングを返す。
+ */
 static VALUE
 rb_grn_encoding_s_get_default (VALUE self)
 {
     return GRNENCODING2RVAL(grn_get_default_encoding());
 }
 
+/*
+ * call-seq:
+ *   Groonga::Encoding.default(encoding)
+ *
+ * デフォルトのエンコーディングを設定する。エンコーディング
+ * の指定方法はGroonga::Encodingを参照。
+ */
 static VALUE
 rb_grn_encoding_s_set_default (VALUE self, VALUE rb_encoding)
 {
     grn_set_default_encoding(RVAL2GRNENCODING(rb_encoding, NULL));
     return rb_encoding;