[NyARToolKit for java]update document

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

diff --git a/lib/src/jp/nyatla/nyartoolkit/nyidmarker/data/INyIdMarkerDataEncoder.java b/lib/src/jp/nyatla/nyartoolkit/nyidmarker/data/INyIdMarkerDataEncoder.java
index 329ea1b..1c4da96 100644 (file)
--- a/lib/src/jp/nyatla/nyartoolkit/nyidmarker/data/INyIdMarkerDataEncoder.java
+++ b/lib/src/jp/nyatla/nyartoolkit/nyidmarker/data/INyIdMarkerDataEncoder.java
@@ -26,9 +26,28 @@ package jp.nyatla.nyartoolkit.nyidmarker.data;
 \r
 import jp.nyatla.nyartoolkit.nyidmarker.NyIdMarkerPattern;\r
 \r
-\r
+/**\r
+ * このインタフェイスは、マーカパターンデータのエンコーダに共通な関数を定義します。\r
+ * NyIdのマーカデータを、利用可能な他形式のデータに変換します。\r
+ */\r
 public interface INyIdMarkerDataEncoder\r
 {\r
+       /**\r
+        * この関数は、マーカパターンデータを他形式のデータに変換します。\r
+        * 実装クラスでは、{@link NyIdMarkerPattern}に格納されるデータを変換する処理を実装してください。\r
+        * @param i_data\r
+        * 変換元のデータ\r
+        * @param o_dest\r
+        * 変換先のデータ\r
+        * @return\r
+        * 変換に成功するとtrueを返します。\r
+        */\r
        public boolean encode(NyIdMarkerPattern i_data,INyIdMarkerData o_dest);\r
+       /**\r
+        * この関数は、このエンコーダの出力形式のオブジェクトを生成して返します。\r
+        * 実装クラスでは、そのクラスの{@link #encode}に入力できるオブジェクトを生成してください。\r
+        * @return\r
+        * 新しいオブジェクト\r
+        */\r
        public INyIdMarkerData createDataInstance();\r
 }\r