[NyARToolKit for java]update document

[nyartoolkit-and/nyartoolkit-and.git] / lib / src / jp / nyatla / nyartoolkit / nyidmarker / data / NyIdMarkerDataEncoder_RawBit.java

diff --git a/lib/src/jp/nyatla/nyartoolkit/nyidmarker/data/NyIdMarkerDataEncoder_RawBit.java b/lib/src/jp/nyatla/nyartoolkit/nyidmarker/data/NyIdMarkerDataEncoder_RawBit.java
index 5f851b9..abb0385 100644 (file)
--- a/lib/src/jp/nyatla/nyartoolkit/nyidmarker/data/NyIdMarkerDataEncoder_RawBit.java
+++ b/lib/src/jp/nyatla/nyartoolkit/nyidmarker/data/NyIdMarkerDataEncoder_RawBit.java
@@ -25,12 +25,17 @@
 package jp.nyatla.nyartoolkit.nyidmarker.data;\r
 \r
 import jp.nyatla.nyartoolkit.nyidmarker.*;\r
-\r
-\r
+/**\r
+ * このクラスは、マーカパターンを{@link NyIdMarkerData_RawBit}型のデータに変換します。\r
+ */\r
 public class NyIdMarkerDataEncoder_RawBit implements INyIdMarkerDataEncoder\r
 {      \r
        private final static int _DOMAIN_ID=0;\r
        private final static int[] _mod_data={7,31,127,511,2047,4095};\r
+       /**\r
+        * この関数は、マーカパターンデータを{@link NyIdMarkerData_RawBit}型のデータに変換します。\r
+        * o_destには、{@link NyIdMarkerData_RawBit}型のオブジェクトを指定してください。\r
+        */\r
        public boolean encode(NyIdMarkerPattern i_data,INyIdMarkerData o_dest)\r
        {\r
                final NyIdMarkerData_RawBit dest=(NyIdMarkerData_RawBit)o_dest;\r
@@ -54,6 +59,9 @@ public class NyIdMarkerDataEncoder_RawBit implements INyIdMarkerDataEncoder
                dest.length=packet_length;\r
                return true;\r
        }\r
+       /**\r
+        * この関数は、{@link NyIdMarkerData_RawBit}型のオブジェクトを生成して返します。\r
+        */\r
        public INyIdMarkerData createDataInstance()\r
        {\r
                return new NyIdMarkerData_RawBit();\r