From c57e553fedfa0adb843aaa67c1ccd30888fadd27 Mon Sep 17 00:00:00 2001
From: nyatla <nyatla@7cac0a50-4618-4814-88d0-24b83990f816>
Date: Wed, 5 Jan 2011 09:13:08 +0000
Subject: [PATCH] git-svn-id:
 http://svn.sourceforge.jp/svnroot/nyartoolkit/NyARToolkit/trunk@786
 7cac0a50-4618-4814-88d0-24b83990f816

---
 .../nyartoolkit/rpf/mklib/ARTKMarkerTable.java     |  96 +++++++++++--------
 .../rpf/utils/LineBaseVertexDetector.java          |  26 +++--
 lib/src/jp/nyatla/nyartoolkit/NyARException.java   |  26 ++---
 .../nyatla/nyartoolkit/core/INyARDisposable.java   |  37 +++++++-
 lib/src/jp/nyatla/nyartoolkit/core/NyARCode.java   | 105 +++++++++++++--------
 lib/src/jp/nyatla/nyartoolkit/core/NyARMat.java    |  78 ++++++++++-----
 lib/src/jp/nyatla/nyartoolkit/core/NyARVec.java    |  61 ++++++++----
 7 files changed, 276 insertions(+), 153 deletions(-)

diff --git a/lib/src.rpf/jp/nyatla/nyartoolkit/rpf/mklib/ARTKMarkerTable.java b/lib/src.rpf/jp/nyatla/nyartoolkit/rpf/mklib/ARTKMarkerTable.java
index a94273b..e840e98 100644
--- a/lib/src.rpf/jp/nyatla/nyartoolkit/rpf/mklib/ARTKMarkerTable.java
+++ b/lib/src.rpf/jp/nyatla/nyartoolkit/rpf/mklib/ARTKMarkerTable.java
@@ -2,43 +2,46 @@ package jp.nyatla.nyartoolkit.rpf.mklib;
 
 import jp.nyatla.nyartoolkit.NyARException;
 import jp.nyatla.nyartoolkit.core.NyARCode;
-import jp.nyatla.nyartoolkit.core.match.NyARMatchPattDeviationColorData;
-import jp.nyatla.nyartoolkit.core.match.NyARMatchPattResult;
-import jp.nyatla.nyartoolkit.core.match.NyARMatchPatt_Color_WITHOUT_PCA;
+import jp.nyatla.nyartoolkit.core.match.*;
 import jp.nyatla.nyartoolkit.core.raster.rgb.NyARRgbRaster;
 import jp.nyatla.nyartoolkit.core.rasterreader.NyARPerspectiveRasterReader;
 import jp.nyatla.nyartoolkit.core.types.NyARBufferType;
 import jp.nyatla.nyartoolkit.core.types.stack.NyARObjectStack;
-import jp.nyatla.nyartoolkit.rpf.reality.nyartk.NyARRealityTarget;
-import jp.nyatla.nyartoolkit.rpf.realitysource.nyartk.NyARRealitySource;
+import jp.nyatla.nyartoolkit.rpf.reality.nyartk.*;
+import jp.nyatla.nyartoolkit.rpf.realitysource.nyartk.*;
 
 /**
- * 簡易なARToolKitパターンテーブルです。
- * このクラスは、ARToolKitスタイルのパターンファイルとIdとメタデータセットテーブルを定義します。
+ * このクラスは、ARToolKitマーカパターンのテーブルです。
+ * マーカパターンをID番号やメタデータに変換する事に役立ちます。
+ * テーブルには、ARToolKitフォーマットのマーカパターンと、ID番号、ユーザ定義のデータのセットを格納します。
+ * このクラスは、テーブルの操作機能と、テーブル要素の検索機能を提供します。
  */
 public class ARTKMarkerTable
 {
 	/**
-	 * selectTarget関数の戻り値を格納します。
+	 * 結果型です。{@link ARTKMarkerTable#getBestMatchTarget}関数の戻り値を格納します。
+	 * <p>memo-
 	 * 入れ子クラスの作れない処理系では、ARTKMarkerTable_GetBestMatchTargetResultとして宣言してください。
+	 * </p>
 	 */
 	public static class GetBestMatchTargetResult
 	{
-		/** 登録時に設定したIDです。*/
+		/** 登録時に設定したID値です。*/
 		public int idtag;
-		/** 登録時に設定した名前です。*/
+		/** 登録時に設定した名前文字列です。*/
 		public String name;
-		/** 登録時に設定したマーカサイズです。*/
+		/** 登録時に設定したマーカ幅です。単位は、mm単位です。*/
 		public double marker_width;
-		/** 登録時に設定したマーカサイズです。*/
+		/** 登録時に設定したマーカ高さです。単位は、mm単位です。*/
 		public double marker_height;
-		/** ARToolKit準拠の、マーカの方位値*/
+		/** ARToolKit準拠の、マーカの方位値です。0&lt;=n&lt;=3の値が入ります。*/
 		public int artk_direction;
-		/** 一致率*/
+		/** パターンの一致率です。0<&lt;n&lt;=1.0の数値が入ります。*/
 		public double confidence;
 	}
-	
-
+	/**
+	 * データを格納するリストクラスを定義します。
+	 */
 	private class MarkerTable extends NyARObjectStack<MarkerTable.SerialTableRow>
 	{
 		public class SerialTableRow
@@ -75,22 +78,30 @@ public class ARTKMarkerTable
 	private NyARMatchPatt_Color_WITHOUT_PCA _match_patt;
 	private NyARMatchPattDeviationColorData _deviation_data;
 	private MarkerTable _table;
+	
+	/** ワーク変数*/
+	private NyARMatchPattResult __tmp_patt_result=new NyARMatchPattResult();
+	
+	
 	/**
-	 * コンストラクタです。
+	 * コンストラクタです。引数にあるパラメータで、空のテーブルを作ります。
 	 * @param i_max
 	 * 登録するアイテムの最大数です。
 	 * @param i_resolution_x
-	 * 登録するパターンの解像度です。
+	 * 登録するパターンの横解像度です。
 	 * ARToolKit互換の標準値は16です。
 	 * @param i_resolution_y
-	 * 登録するパターンの解像度です。
+	 * 登録するパターンの縦解像度です。
 	 * ARToolKit互換の標準値は16です。
 	 * @param i_edge_x
-	 * エッジ部分の割合です。ARToolKit互換の標準値は25です。
+	 * エッジ部分の割合です。0<n<100の数値を指定します。
+	 * ARToolKit互換の標準値は25です。
 	 * @param i_edge_y
-	 * エッジ部分の割合です。ARToolKit互換の標準値は25です。
+	 * エッジ部分の割合です。0<n<100の数値を指定します。
+	 * ARToolKit互換の標準値は25です。
 	 * @param i_sample_per_pix
-	 * パターン取得の1ピクセルあたりのサンプリング数です。1なら1Pixel=1,2なら1Pixel=4のサンプリングをします。
+	 * 元画像からパターンを取得する時の、1ピクセル当たりのサンプリング数です。
+	 * 1なら1Pixel=1,2なら1Pixel=4ピクセルの画素を、元画像からサンプリングをします。
 	 * ARToolKit互換の標準値は4です。
 	 * 高解像度(64以上)のパターンを用いるときは、サンプリング数を低く設定してください。
 	 * @throws NyARException 
@@ -108,19 +119,20 @@ public class ARTKMarkerTable
 		this._match_patt=new NyARMatchPatt_Color_WITHOUT_PCA(i_resolution_x,i_resolution_y);
 	}
 	/**
-	 * ARTKパターンコードを、テーブルに追加します。このパターンコードのメタデータとして、IDと名前を指定できます。
+	 * テーブル操作関数です。{@link NyARCode}を元にして、テーブルにマーカパターンを追加します。
 	 * @param i_code
-	 * ARToolKit形式のパターンコードを格納したオブジェクト。このオブジェクトは、関数成功後はインスタンスに所有されます。
+	 * ARToolKit形式のパターンコードを格納したオブジェクト。このオブジェクトは、関数成功後はインスタンスが所有します。
 	 * パターンコードの解像度は、コンストラクタに指定した高さと幅である必要があります。
 	 * @param i_id
-	 * このマーカを識別するユーザ定義のID値です。任意の値を指定できます。不要な場合は0を指定してください。
+	 * このマーカを識別する、ユーザ定義のID値です。任意の値を指定できます。不要な場合は0を指定してください。
 	 * @param i_name
 	 * ユーザ定義の名前です。任意の値を指定できます。不要な場合はnullを指定して下さい。
 	 * @param i_width
-	 * マーカの高さ[通常mm単位]
+	 * 実際のマーカの高さです。[通常mm単位]
 	 * @param i_height
-	 * マーカの幅[通常mm単位]
+	 * 実際のマーカの幅です。[通常mm単位]
 	 * @return
+	 * 登録に成功すると、trueを返します。
 	 */
 	public boolean addMarker(NyARCode i_code,int i_id,String i_name,double i_width,double i_height)
 	{
@@ -133,17 +145,19 @@ public class ARTKMarkerTable
 		return true;
 	}
 	/**
-	 * i_rasterからパターンコードを生成して、テーブルへ追加します。
+	 * テーブル操作関数です。{@link NyARRgbRaster}クラスのオブジェクトからマーカパターンを生成して、テーブルへ追加します。方位は、上方向がdirection=0になります。
 	 * @param i_raster
+	 * マーカパターンの元となるラスタを指定します。解像度は、コンストラクタで指定したものと同じでなければなりません。
 	 * @param i_id
 	 * このマーカを識別するユーザ定義のID値です。任意の値を指定できます。不要な場合は0を指定してください。
 	 * @param i_name
 	 * ユーザ定義の名前です。任意の値を指定できます。不要な場合はnullを指定して下さい。
 	 * @param i_width
-	 * マーカの高さ[通常mm単位]
+	 * 実際のマーカの高さです。[通常mm単位]
 	 * @param i_height
-	 * マーカの幅[通常mm単位]
+	 * 実際のマーカの幅です。[通常mm単位]
 	 * @return
+	 * 登録に成功すると、trueを返します。
 	 * @throws NyARException
 	 */
 	public boolean addMarker(NyARRgbRaster i_raster,int i_id,String i_name,double i_width,double i_height) throws NyARException
@@ -158,17 +172,19 @@ public class ARTKMarkerTable
 		return true;
 	}
 	/**
-	 * ARToolkit準拠のパターンファイルからパターンコードを生成して、テーブルへ追加します。
+	 * テーブル操作関数です。ARToolkit準拠のパターンファイルを読み込み、テーブルへ追加します。
 	 * @param i_filename
+	 * パターンファイルのファイルパスを指定します。
 	 * @param i_id
 	 * このマーカを識別するユーザ定義のID値です。任意の値を指定できます。不要な場合は0を指定してください。
 	 * @param i_name
 	 * ユーザ定義の名前です。任意の値を指定できます。不要な場合はnullを指定して下さい。
 	 * @param i_width
-	 * マーカの高さ[通常mm単位]
+	 * 実際のマーカの高さです。[通常mm単位]
 	 * @param i_height
-	 * マーカの幅[通常mm単位]
+	 * 実際のマーカの幅です。[通常mm単位]
 	 * @return
+	 * 登録に成功すると、trueを返します。
 	 * @throws NyARException
 	 */
 	public boolean addMarkerFromARPattFile(String i_filename,int i_id,String i_name,double i_width,double i_height) throws NyARException
@@ -183,19 +199,19 @@ public class ARTKMarkerTable
 		return true;
 	}	
 	
-	private NyARMatchPattResult __tmp_patt_result=new NyARMatchPattResult();
 	/**
-	 * RealityTargetに最も一致するパターンをテーブルから検索して、メタデータを返します。
+	 * テーブル検索関数です。
+	 * {@link NyARRealityTarget}を元に{@link NyARRealitySource}からパターンのサンプリングを行い、最も一致するマーカパターンをテーブルから検索します。
+	 * 検索キーとなる{@link NyARRealityTarget}は、{@link NyARReality}派生クラスから取得した物を指定します。
 	 * @param i_target
-	 * Realityが検出したターゲット。
-	 * Unknownターゲットを指定すること。
+	 * 検索キーとなる、Unknownステータスの{@link NyARRealityTarget}クラスのオブジェクトを指定します。
 	 * @param i_rtsorce
-	 * i_targetを検出したRealitySourceインスタンス。
+	 * i_targetを検出した{@link NyARRealitySource}のインスタンスを指定します。関数は、このソースからパターン取得を行います。
 	 * @param o_result
 	 * 返却値を格納するインスタンスを設定します。
-	 * 返却値がtrueの場合のみ、内容が更新されています。
 	 * @return
-	 * 特定に成功すると、trueを返します。
+	 * パターンのサンプリングに成功すると、trueを返します。
+	 * 返却値がtrueの場合のみ、内容が更新されています。
 	 * @throws NyARException 
 	 */
 	public boolean getBestMatchTarget(NyARRealityTarget i_target,NyARRealitySource i_rtsorce,GetBestMatchTargetResult o_result) throws NyARException
diff --git a/lib/src.rpf/jp/nyatla/nyartoolkit/rpf/utils/LineBaseVertexDetector.java b/lib/src.rpf/jp/nyatla/nyartoolkit/rpf/utils/LineBaseVertexDetector.java
index 0decca2..a7134e4 100644
--- a/lib/src.rpf/jp/nyatla/nyartoolkit/rpf/utils/LineBaseVertexDetector.java
+++ b/lib/src.rpf/jp/nyatla/nyartoolkit/rpf/utils/LineBaseVertexDetector.java
@@ -4,32 +4,27 @@ import jp.nyatla.nyartoolkit.NyARException;
 import jp.nyatla.nyartoolkit.core.types.*;
 
 /**
- * このクラスは、直線式の集合から頂点集合を計算する関数を提供します。
+ * このクラスは、4本の直線式から、凸包の頂点を計算する機能を提供します。
  */
 public class LineBaseVertexDetector
 {
-	/**
-	 * 頂点パターンテーブル
-	 * 頂点用の、存在しないIDに対応した、調査テーブル。4頂点の時も使う。
-	 */
+	/** 頂点の組合せテーブル(4,5頂点用)*/
 	private final static int[][] _45vertextable={
 			{1,2,4,3},{0,2,5,3},{0,1,5,4},{0,1,5,4},{0,2,5,3},{1,2,4,3}};
-	/**
-	 * 頂点パターンテーブル(6用)
-	 */
+	/** 頂点組合せテーブル。(6頂点用)*/
 	private final static int[][] _order_table={{0,1,5,4},{0,2,5,3},{1,2,4,3}};
+	/** ワーク変数*/
 	private NyARDoublePoint2d[] __wk_v=NyARDoublePoint2d.createArray(6);
 	/**
-	 * 適当に与えられた4線分から、四角形の頂点を計算する。
+	 * ４直線の交点から、凸包の頂点座標を計算します。
 	 * @param i_line
-	 * 4線分を格納した配列
+	 * 直線式の配列です。要素数は4である必要があります。
 	 * @param o_point
-	 * 検出した4頂点
+	 * 検出した頂点の座標です。要素数は4である必要があります。
 	 * @return
-	 * 四角形を検出したらtrue
+	 * 凸包を計算できると、trueを返します。
 	 * @throws NyARException
 	 */
-
 	public boolean line2SquareVertex(VecLinearCoordinates.VecLinearCoordinatePoint[] i_line,NyARDoublePoint2d[] o_point) throws NyARException
 	{
 		
@@ -98,10 +93,13 @@ public class LineBaseVertexDetector
 	}
 
 	/**
-	 * 4頂点を巡回して、正の外積の個数を数える。
+	 * 4頂点を巡回して、正の外積数を数えます。
 	 * @param p
+	 * 頂点配列。4要素である事。
 	 * @param order
+	 * 頂点のインデクス配列。4要素である事。
 	 * @return
+	 * 正の外積数
 	 */
 	private final static int countPlusExteriorProduct(NyARDoublePoint2d[] p,int[] order)
 	{
diff --git a/lib/src/jp/nyatla/nyartoolkit/NyARException.java b/lib/src/jp/nyatla/nyartoolkit/NyARException.java
index 8956074..e4aa532 100644
--- a/lib/src/jp/nyatla/nyartoolkit/NyARException.java
+++ b/lib/src/jp/nyatla/nyartoolkit/NyARException.java
@@ -32,22 +32,23 @@ package jp.nyatla.nyartoolkit;
 
 /**
  * NyARToolkitライブラリが生成するExceptionのクラスです。
- * このクラスは、NyARToolkitライブラリ内でのみ使用します。
- *
+ * このクラスは、NyARToolkitライブラリでのみ使用します。
  */
 public class NyARException extends Exception
 {
 	private static final long serialVersionUID = 1L;
 
 	/**
-	 * コンストラクタです。例外オブジェクトを生成します。
+	 * コンストラクタです。
+	 * 例外オブジェクトを生成します。
 	 */
 	public NyARException()
 	{
 		super();
 	}
 	/**
-	 * コンストラクタです。例外オブジェクト継承して、例外を生成します。
+	 * コンストラクタです。
+	 * 例外オブジェクト継承して、例外を生成します。
 	 * @param e
 	 * 継承する例外オブジェクト
 	 */
@@ -56,7 +57,8 @@ public class NyARException extends Exception
 		super(e);
 	}
 	/**
-	 * コンストラクタです。メッセージを指定して、例外を生成します。
+	 * コンストラクタです。
+	 * メッセージを指定して、例外を生成します。
 	 * @param m
 	 */
 	public NyARException(String m)
@@ -64,19 +66,20 @@ public class NyARException extends Exception
 		super(m);
 	}
 	/**
-	 * ライブラリ開発者向けの関数です。メッセージを指定して、例外をスローします。
-	 * この関数は、NyARToolkitの仕様外動作を補足するために使います。
+	 * ライブラリ開発者向けの関数です。
+	 * 意図的に例外を発生するときに、コードに埋め込みます。
 	 * @param m
+	 * 例外メッセージを指定します。
 	 * @throws NyARException
 	 */
-
 	public static void trap(String m) throws NyARException
 	{
 		throw new NyARException("トラップ:" + m);
 	}
 	/**
-	 * ライブラリ開発者向けの関数です。"Not Implement!"メッセージを指定して、例外をスローします。
-	 * この関数は、NyARToolkitの未実装部分に記述して使います。
+	 * ライブラリ開発者向けの関数です。
+	 * "Not Implement!"メッセージを指定して、例外をスローします。
+	 * この関数は、NyARToolkitの未実装部分に埋め込みます。
 	 * @throws NyARException
 	 */
 	public static void notImplement() throws NyARException
@@ -84,7 +87,8 @@ public class NyARException extends Exception
 		throw new NyARException("Not Implement!");
 	}
 	/**
-	 * この関数は使用不能です。（別の関数を使用してください。）
+	 * ライブラリ開発者向けの関数です。
+	 * 関数が使用不能である事を、例外で通知します。
 	 * @throws NyARException
 	 */
 	public static void unavailability() throws NyARException
diff --git a/lib/src/jp/nyatla/nyartoolkit/core/INyARDisposable.java b/lib/src/jp/nyatla/nyartoolkit/core/INyARDisposable.java
index dbdf9e5..ceff0fc 100644
--- a/lib/src/jp/nyatla/nyartoolkit/core/INyARDisposable.java
+++ b/lib/src/jp/nyatla/nyartoolkit/core/INyARDisposable.java
@@ -1,13 +1,44 @@
+/* 
+ * PROJECT: NyARToolkit
+ * --------------------------------------------------------------------------------
+ * This work is based on the original ARToolKit developed by
+ *   Hirokazu Kato
+ *   Mark Billinghurst
+ *   HITLab, University of Washington, Seattle
+ * http://www.hitl.washington.edu/artoolkit/
+ *
+ * The NyARToolkit is Java edition ARToolKit class library.
+ * Copyright (C)2008-2009 Ryo Iizuka
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ * 
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ * 
+ * For further information please contact.
+ *	http://nyatla.jp/nyatoolkit/
+ *	<airmail(at)ebony.plala.or.jp> or <nyatla(at)nyatla.jp>
+ * 
+ */
 package jp.nyatla.nyartoolkit.core;
 
 /**
- * オブジェクトの破棄タイミングを受け取るインタフェイスです。
- *
+ * オブジェクト破棄のタイミングを受け取るインタフェイスです。
+ * アンマネージリソースの破棄コントロールや、オブジェクトプールの制御に使います。
  */
 public interface INyARDisposable
 {
 	/**
-	 * オブジェクトの終期化のタイミングを与えます。オブジェクトの終期化に必要な処理を実装します。
+	 * オブジェクトの終期化のタイミングを与えます。
+	 * オブジェクトの終期化に必要な処理を実装しでください。
 	 */
 	public void dispose();
 }
diff --git a/lib/src/jp/nyatla/nyartoolkit/core/NyARCode.java b/lib/src/jp/nyatla/nyartoolkit/core/NyARCode.java
index 5fc15a7..7b4adde 100644
--- a/lib/src/jp/nyatla/nyartoolkit/core/NyARCode.java
+++ b/lib/src/jp/nyatla/nyartoolkit/core/NyARCode.java
@@ -43,23 +43,25 @@ import jp.nyatla.nyartoolkit.core.raster.rgb.NyARRgbRaster;
 import jp.nyatla.nyartoolkit.core.types.NyARBufferType;
 
 /**
- * NyARCodeクラスの支援クラスです。このクラスは、NyARCodeのマーカファイル読み取り機能を担当します。
- * InputStreamからARToolkit形式のマーカデータを読み取って配列に格納する手順を実装します。
+ * {@link NyARCode}クラスの支援クラスです。
+ * このクラスは、{@link NyARCode}のマーカファイル読み取り機能のうち、InputStreamからARToolkit形式のマーカデータを読み取って配列に格納する手順を実装します。
+ * {@link NyARCode}以外から使用することはありません。
  */
 class NyARCodeFileReader
 {
 
 	/**
-	 * ImputStreamからARToolKit形式のマーカデータを読み込んでo_raster[4]に格納します。
+	 * ImputStreamからARToolKit形式のマーカデータを読み、o_raster[4]に格納します。
 	 * @param i_stream
 	 * 読出し元のストリームです。
 	 * @param o_raster
-	 * 出力先のラスタ配列です。バッファ形式は形式はINT1D_X8R8G8B8_32であり、全て同一なサイズである必要があります。
+	 * 出力先のラスタ配列です。
+	 * バッファ形式は形式はINT1D_X8R8G8B8_32であり、4要素、かつ全て同一なサイズである必要があります。
 	 * @throws NyARException
 	 */
 	public static void loadFromARToolKitFormFile(InputStream i_stream,NyARRaster[] o_raster) throws NyARException
 	{
-		assert o_raster.length==4;
+		assert(o_raster.length==4);
 		//4個の要素をラスタにセットする。
 		try {
 			StreamTokenizer st = new StreamTokenizer(new InputStreamReader(i_stream));
@@ -75,11 +77,11 @@ class NyARCodeFileReader
 		return;
 	}
 	/**
-	 * ImputStreamからARToolKit形式のマーカデータを読み込んでo_codeに格納します。
+	 * ImputStreamからARToolKit形式のマーカデータを読み込み、o_codeオブジェクトへ格納します。
 	 * @param i_stream
 	 * 読出し元のストリームです。
 	 * @param o_code
-	 * 出力先のNyARCodeオブジェクトです。
+	 * 出力先の{@link NyARCode}オブジェクトです。
 	 * @throws NyARException
 	 */
 	public static void loadFromARToolKitFormFile(InputStream i_stream,NyARCode o_code) throws NyARException
@@ -105,13 +107,14 @@ class NyARCodeFileReader
 		return;
 	}
 	/**
-	 * 1ブロック分のXRGBデータをi_stからo_bufへ読みだします。
+	 * ストリームi_stから、1ブロック(1方位分)のXRGBデータをからo_bufへ読みだします。
 	 * @param i_st
-	 * 入力元のStreamTokenizerを指定します。関数実行後、読み取り位置は更新されます。
+	 * 入力元のStreamTokenizerを指定します。
+	 * i_stの読み取り位置は更新されます。
 	 * @param i_width
-	 * パターンの横幅です。
+	 * パターンの横解像度(pixel)です。
 	 * @param i_height
-	 * パターンの縦幅です。
+	 * パターンの縦解像度(pixel)です。
 	 * @param o_buf
 	 * 読み取った値を格納する配列です。
 	 * @throws NyARException
@@ -144,8 +147,8 @@ class NyARCodeFileReader
 }
 
 /**
- * ARToolKitのマーカーパターン1個のデータに相当するクラスです。
- * マーカーパターンに対する、ARToolKit相当のプロパティ値を提供します。
+ * ARToolKitのマーカーパターン1個のデータを格納するクラスです。
+ * マーカーパターンのプロパティと、データのロード機能を提供します。
  */
 public class NyARCode
 {
@@ -155,39 +158,55 @@ public class NyARCode
 	private int _height;
 	
 	/**
-	 * directionを指定して、NyARMatchPattDeviationColorDataオブジェクトを取得します。
+	 * 指定したdirection(方位)の{@link NyARMatchPattDeviationColorData}オブジェクトの参照値を返します。
 	 * @param i_index
-	 * 0<=n<4の数値
+	 * 方位インデクスの値を指定します。
+	 * 範囲は、0&lt;=n&lt;=3の数値です。
 	 * @return
-	 * NyARMatchPattDeviationColorDataオブジェクト
+	 * 指定した方位の{@link NyARMatchPattDeviationColorData}オブジェクトを返します。
 	 */
 	public NyARMatchPattDeviationColorData getColorData(int i_index)
 	{
 		return this._color_pat[i_index];
 	}
+	/**
+	 * 指定したdirection(方位)の{@link NyARMatchPattDeviationBlackWhiteData}オブジェクトの参照値を返します。
+	 * @param i_index
+	 * 方位インデクスの値を指定します。
+	 * 範囲は、0&lt;=n&lt;=3の数値です。
+	 * @return
+	 * 指定した方位の{@link NyARMatchPattDeviationBlackWhiteData}オブジェクトを返します。
+	 */
 	public NyARMatchPattDeviationBlackWhiteData getBlackWhiteData(int i_index)
 	{
 		return this._bw_pat[i_index];
-	}	
+	}
+	/**
+	 * ARマーカの横解像度を返します。
+	 * @return
+	 * 解像度値
+	 */
 	public int getWidth()
 	{
 		return _width;
 	}
 
 	/**
-	 * パターンデータの高さを取得します。
+	 * ARマーカの縦解像度を返します。
 	 * @return
+	 * 解像度値
 	 */
 	public int getHeight()
 	{
 		return _height;
 	}
 	/**
-	 * コンストラクタです。空のNyARCodeオブジェクトを作成します。
+	 * コンストラクタです。
+	 * 空のNyARCodeオブジェクトを作成します。
 	 * @param i_width
-	 * 作成するマーカパターンの幅
+	 * 作成するマーカパターンの横解像度
 	 * @param i_height
-	 * 作成するマーカパターンの高さ
+	 * 作成するマーカパターンの縦解像度
 	 * @throws NyARException
 	 */
 	public NyARCode(int i_width, int i_height) throws NyARException
@@ -202,10 +221,10 @@ public class NyARCode
 		return;
 	}
 	/**
-	 * ファイル名を指定して、パターンデータをロードします。
-	 * ロードするパターンデータのサイズは、現在の値と同じである必要があります。
+	 * ARToolKit形式のパターンデータをファイルからロードします。
+	 * ロードするパターンデータの縦横解像度は、このインスタンスの値と同じである必要があります。
 	 * @param filename
-	 * ARToolKit形式のパターンデータファイルの名前
+	 * ARToolKit形式のパターンデータファイルのパス名
 	 * @throws NyARException
 	 */
 	public void loadARPattFromFile(String filename) throws NyARException
@@ -218,10 +237,23 @@ public class NyARCode
 		return;
 	}
 	/**
-	 * 4枚のラスタから、マーカーパターンを生成して格納します。
+	 * inputStreamから、ARToolKit形式のパターンデータをロードします。
+	 * ロードするパターンデータの縦横解像度は、このインスタンスの値と同じである必要があります。
+	 * @param i_stream
+	 * 読出し元のStreamオブジェクト
+	 * @throws NyARException
+	 */
+	public void loadARPatt(InputStream i_stream) throws NyARException
+	{
+		//ラスタにパターンをロードする。
+		NyARCodeFileReader.loadFromARToolKitFormFile(i_stream,this);
+		return;
+	}	
+	/**
+	 * 4枚のラスタオブジェクトから、マーカーパターンを生成して格納します。
 	 * @param i_raster
-	 * direction毎のパターンを格納したラスタ配列を指定します。
-	 * ラスタは同一なサイズ、かつマーカーパターンと同じサイズである必要があります。
+	 * パターンデータを格納したラスタオブジェクト配列を指定します。
+	 * ラスタは同一な解像度であり、かつこのインスタンスと同じ解像度である必要があります。
 	 * 格納順は、パターンの右上が、1,2,3,4象限になる順番です。
 	 * @throws NyARException
 	 */
@@ -235,9 +267,11 @@ public class NyARCode
 		return;
 	}
 	/**
-	 * 1枚のラスタから、マーカーパターンを生成して格納します。
+	 * 1枚のラスタオブジェクトから、マーカーパターンを生成して格納します。
+	 * 残りの3枚のデータは、関数がi_rasterを回転させて求めます。
 	 * @param i_raster
-	 * 基準となるラスタを指定します。ラスタの解像度は、ARマーカコードと同じである必要があります。
+	 * パターンデータを格納したラスタオブジェクトを指定します。
+	 * ラスタは、このインスタンスと同じ解像度である必要があります。
 	 * @throws NyARException
 	 */	
 	public void setRaster(INyARRgbRaster i_raster) throws NyARException
@@ -249,16 +283,5 @@ public class NyARCode
 		return;
 	}
 	
-	/**
-	 * inputStreamから、パターンデータをロードします。
-	 * ロードするパターンのサイズは、現在の値と同じである必要があります。
-	 * @param i_stream
-	 * @throws NyARException
-	 */
-	public void loadARPatt(InputStream i_stream) throws NyARException
-	{
-		//ラスタにパターンをロードする。
-		NyARCodeFileReader.loadFromARToolKitFormFile(i_stream,this);
-		return;
-	}
+
 }
diff --git a/lib/src/jp/nyatla/nyartoolkit/core/NyARMat.java b/lib/src/jp/nyatla/nyartoolkit/core/NyARMat.java
index 49da105..f627667 100644
--- a/lib/src/jp/nyatla/nyartoolkit/core/NyARMat.java
+++ b/lib/src/jp/nyatla/nyartoolkit/core/NyARMat.java
@@ -31,21 +31,20 @@
 package jp.nyatla.nyartoolkit.core;
 
 import jp.nyatla.nyartoolkit.NyARException;
+import jp.nyatla.nyartoolkit.core.types.matrix.*;
 
 /**
- * ARToolKit由来の、可変サイズの行列計算クラスです。
+ * 可変サイズの行列計算クラスです。
  * ARToolKitのARMat構造体と、その処理関数に相当する機能があります。
- * 2x2,3x3,4x4行列については、NyAToolKitの行列計算クラスの方が高速な場合がありますので、必要に応じて選択して下さい。
- * @note
+ * 2x2,3x3,4x4行列については、NyAToolKitの行列計算クラス({@link NyARDoubleMatrix44},{@link NyARDoubleMatrix33},{@link NyARDoubleMatrix22},)
+ * がありますので、こちらを使ってください。
+ * <p>memo:
  * このクラスは、今後統合・削除する可能性があります。
+ * </p>
  */
 public class NyARMat
 {
-	/**
-	 * 配列値を格納するバッファ
-	 * 配列サイズと行列サイズは必ずしも一致しないことに注意。
-	 * 配列のサイズを行列の大きさとして使わないこと！
-	 */
+	/**　配列値を格納するバッファ。配列サイズと行列サイズは必ずしも一致しないことに注意。配列のサイズを行列の大きさとして使わないこと！*/
 	protected double[][] _m;
 	private int[] __matrixSelfInv_nos;
 
@@ -53,7 +52,8 @@ public class NyARMat
 	protected int row;
 
 	/**
-	 * デフォルトコンストラクタは機能しません。
+	 * デフォルトコンストラクタ。
+	 * 機能しません。
 	 * @throws NyARException
 	 */
 	protected NyARMat() throws NyARException
@@ -61,9 +61,12 @@ public class NyARMat
 		throw new NyARException();
 	}
 	/**
-	 * コンストラクタです。サイズを指定して、NyARMatオブジェクトを作成します。
+	 * コンストラクタです。
+	 * 行列のサイズを指定して、NyARMatオブジェクトを作成します。
 	 * @param i_row
+	 * 行数です。
 	 * @param i_clm
+	 * 列数です。
 	 */
 	public NyARMat(int i_row, int i_clm)
 	{
@@ -77,6 +80,7 @@ public class NyARMat
 	/**
 	 * 行列の列数を返します。
 	 * @return
+	 * 行列の列数。
 	 */
 	public int getClm()
 	{
@@ -85,6 +89,7 @@ public class NyARMat
 	/**
 	 * 行列の行数を返します。
 	 * @return
+	 * 行列の列数
 	 */
 	public int getRow()
 	{
@@ -93,9 +98,11 @@ public class NyARMat
 	
 	/**
 	 * 行列のサイズを変更します。
-	 * 実行後、行列の各値は不定になります。
+	 * 関数を実行すると、行列の各値は不定になります。
 	 * @param i_row
+	 * 新しい行数
 	 * @param i_clm
+	 * 新しい列数。
 	 */
 	public void realloc(int i_row, int i_clm)
 	{
@@ -110,9 +117,6 @@ public class NyARMat
 		this.row = i_row;
 		return;
 	}
-	
-	
-	
 	/**
 	 * 行列同士の掛け算を実行します。
 	 * i_mat_aとi_mat_bの積を計算して、thisへ格納します。
@@ -146,6 +150,7 @@ public class NyARMat
 	 * 逆行列を計算して、thisへ格納します。
 	 * @return
 	 *　逆行列が計算できたかの、真偽値を返します。trueなら、逆行列が存在します。falseなら、逆行列はありません。
+	 * 失敗すると、thisの内容は不定になります。
 	 * @throws NyARException
 	 */
 	public boolean matrixSelfInv() throws NyARException
@@ -273,7 +278,10 @@ public class NyARMat
 	}
 	/**
 	 * 行列のバッファを返します。
+	 * 返却値の有効期間に注意してください。
+	 * この値の有効時間は、次にこのこのインスタンスの関数を実行するまでの間です。
 	 * @return
+	 * 行列のバッファ
 	 */
 	public double[][] getArray()
 	{
@@ -282,13 +290,12 @@ public class NyARMat
 
 
 	/**
-	 * ARToolKitのarMatrixTrans関数と同等な関数です。
-	 * sourceの転置行列をdestに得ます。
+	 * ARToolKitのarMatrixTrans関数と同等な関数です。sourceの転置行列をdestに得ます。
+	 * この関数は未チェックの為、実行すると例外が発生します。
 	 * @param dest
 	 * 出力先のオブジェクト
 	 * @param source
 	 * 入力元のオブジェクト
-	 * @return
 	 */
 	public static void matrixTrans(NyARMat dest, NyARMat source) throws NyARException
 	{
@@ -305,9 +312,10 @@ public class NyARMat
 	}
 
 	/**
-	 * ARToolKitの、arMatrixUnit関数と同等な関数です。
-	 * unitを単位行列に初期化します。
+	 * ARToolKitの、arMatrixUnit関数と同等な関数です。unitを単位行列に初期化します。
+	 * この関数は未チェックの為、実行すると例外が発生します。
 	 * @param unit
+	 * 操作するオブジェクト。
 	 */
 	public static void matrixUnit(NyARMat unit) throws NyARException
 	{
@@ -330,7 +338,7 @@ public class NyARMat
 	/**
 	 * i_sourceの内容を、thisへコピーします。
 	 * @param i_source
-	 * @return
+	 * コピー元のインスタンスです。
 	 */
 	public void matrixDup(NyARMat i_source) throws NyARException
 	{
@@ -351,6 +359,7 @@ public class NyARMat
 	/**
 	 * オブジェクトを複製します。
 	 * @return
+	 * 複製したオブジェクト。
 	 * @throws NyARException
 	 */
 	public NyARMat matrixAllocDup() throws NyARException
@@ -380,9 +389,8 @@ public class NyARMat
 	/**
 	 * ARToolKitのEX関数と同等な関数です。
 	 * 詳細は不明です。
-	 * @param input
 	 * @param mean
-	 * @return
+	 * 不明
 	 * @throws NyARException
 	 */
 	private void PCA_EX(NyARVec mean) throws NyARException
@@ -418,8 +426,9 @@ public class NyARMat
 	 * ARToolKitのCENTER関数と同等な関数です。
 	 * 詳細は不明です。
 	 * @param inout
+	 * 不明
 	 * @param mean
-	 * @return
+	 * 不明
 	 */
 	private static void PCA_CENTER(NyARMat inout, NyARVec mean)throws NyARException
 	{
@@ -466,9 +475,13 @@ public class NyARMat
 	}
 
 	/**
-	 * ARToolKitのx_by_xtと同等な関数です。詳細は不明です。
+	 * ARToolKitのx_by_xtと同等な関数です。
+	 * 詳細は不明です。
+	 * この関数は未チェックの為、使用すると例外が発生します。
 	 * @param input
+	 * 不明
 	 * @param output
+	 * 不明
 	 * @throws NyARException
 	 */
 	private static void PCA_x_by_xt(NyARMat input, NyARMat output) throws NyARException
@@ -512,7 +525,9 @@ public class NyARMat
 	 * ARToolKitのxt_by_x関数と同等な関数です。
 	 * 詳細は不明です。
 	 * @param input
+	 * 不明
 	 * @param i_output
+	 * 不明
 	 * @throws NyARException
 	 */
 	private static void PCA_xt_by_x(NyARMat input, NyARMat i_output) throws NyARException
@@ -549,8 +564,9 @@ public class NyARMat
 
 	/**
 	 * ARToolKitのQRM関数と同等な関数です。
-	 * @param a
+	 * 詳細は不明です。
 	 * @param dv
+	 * 不明
 	 * @throws NyARException
 	 */
 	private void PCA_QRM(NyARVec dv) throws NyARException
@@ -684,9 +700,13 @@ public class NyARMat
 	 * ARToolKitのEV_create関数と同等な関数です。
 	 * 詳細は不明です。
 	 * @param input
+	 * 不明。
 	 * @param u
+	 * 不明。
 	 * @param output
+	 * 不明。
 	 * @param ev
+	 * 不明。
 	 * @throws NyARException
 	 */
 	private static void PCA_EV_create(NyARMat input, NyARMat u, NyARMat output,NyARVec ev) throws NyARException
@@ -759,7 +779,9 @@ public class NyARMat
 	 * ARToolKitのPCA関数と同等な関数です。
 	 * 詳細は不明です。
 	 * @param output
+	 * 不明
 	 * @param o_ev
+	 * 不明
 	 * @throws NyARException
 	 */
 	private void PCA_PCA(NyARMat o_output, NyARVec o_ev) throws NyARException
@@ -830,8 +852,11 @@ public class NyARMat
 	 * 現在の行列に主成分分析を実行して、結果をthisと引数へ格納します。
 	 * 詳細は不明です。
 	 * @param o_evec
+	 * 不明
 	 * @param o_ev
+	 * 不明
 	 * @param o_mean
+	 * 不明
 	 * @throws NyARException
 	 */
 	public void pca(NyARMat o_evec, NyARVec o_ev, NyARVec o_mean)throws NyARException
@@ -884,10 +909,11 @@ public class NyARMat
 	 * ARToolKitの、arVecTridiagonalize関数と同等な関数です。
 	 * 詳細は不明です。
 	 * @param d
+	 * 不明
 	 * @param e
+	 * 不明
 	 * @param i_e_start
 	 * 演算開始列(よくわからないけどarVecTridiagonalizeの呼び出し元でなんかしてる)
-	 * @return
 	 * @throws NyARException
 	 */
 	private void vecTridiagonalize(NyARVec d, NyARVec e, int i_e_start)throws NyARException
diff --git a/lib/src/jp/nyatla/nyartoolkit/core/NyARVec.java b/lib/src/jp/nyatla/nyartoolkit/core/NyARVec.java
index a38a0a6..f419eac 100644
--- a/lib/src/jp/nyatla/nyartoolkit/core/NyARVec.java
+++ b/lib/src/jp/nyatla/nyartoolkit/core/NyARVec.java
@@ -33,23 +33,37 @@ package jp.nyatla.nyartoolkit.core;
 import jp.nyatla.nyartoolkit.NyARException;
 
 
-
+/**
+ * このクラスは、ARToolKit由来のベクトル値計算関数を提供します。
+ * <p>memo:
+ * このクラスは、今後統合・削除する可能性があります。
+ * </p>
+ */
 public class NyARVec
 {
+	/** ベクトルの列数*/
 	private int clm;
+	/** ベクトル値を格納する配列*/
+	private double[] v;
 
+
+	/**
+	 * コンストラクタです。
+	 * 列数を指定して、インスタンスを生成します。
+	 * @param i_clm
+	 * 列数です。
+	 */
 	public NyARVec(int i_clm)
 	{
 		v = new double[i_clm];
 		clm = i_clm;
 	}
 
-	private double[] v;
-
 	/**
-	 * i_clmサイズの列を格納できるように列サイズを変更します。 実行後、列の各値は不定になります。
-	 * 
+	 * ベクトルのバッファサイズを、i_clmに十分になるように変更します。
+	 * 実行後、列の各値は不定になります。
 	 * @param i_clm
+	 * 新しい列数
 	 */
 	public void realloc(int i_clm)
 	{
@@ -62,26 +76,36 @@ public class NyARVec
 		this.clm = i_clm;
 	}
 
+	/**
+	 * ベクトルの列数を返します。
+	 * @return
+	 * ベクトルの列数
+	 */
 	public int getClm()
 	{
 		return clm;
 	}
 
+	/**
+	 * ベクトル値を格納した配列の参照値を返します。
+	 * @return
+	 * 配列の参照値
+	 */
 	public double[] getArray()
 	{
 		return v;
 	}
 
-
-
 	/**
-	 * arVecInnerproduct関数の代替品
-	 * 
-	 * @param x
+	 * arVecInnerproduct関数の同等品です。
+	 * この関数は動作チェックをしておらず、機能しません。
+	 * 詳細は不明です。
 	 * @param y
+	 * 不明。
 	 * @param i_start
-	 *            演算開始列(よくわからないけどarVecTridiagonalizeの呼び出し元でなんかしてる)
+	 * 演算開始列(よくわからないけどarVecTridiagonalizeの呼び出し元でなんかしてる)
 	 * @return
+	 * 不明。
 	 * @throws NyARException
 	 */
 	public double vecInnerproduct(NyARVec y, int i_start) throws NyARException
@@ -102,12 +126,12 @@ public class NyARVec
 	}
 
 	/**
-	 * double arVecHousehold関数の代替品
-	 * 
-	 * @param x
+	 * arVecHousehold関数の同等品です。
+	 * 詳細は不明です。
 	 * @param i_start
-	 *            演算開始列(よくわからないけどarVecTridiagonalizeの呼び出し元でなんかしてる)
+	 * 演算開始列(よくわからないけどarVecTridiagonalizeの呼び出し元でなんかしてる)
 	 * @return
+	 * 不明。
 	 * @throws NyARException
 	 */
 	public double vecHousehold(int i_start) throws NyARException
@@ -135,10 +159,11 @@ public class NyARVec
 	}
 
 	/**
-	 * 現在ラップしている配列を取り外して、新しい配列をラップします。
-	 * 
-	 * @param i_v
+	 * 現在ラップしている配列を取り外して、新しい配列と、列数をセットします。
+	 * @param i_array
+	 * 新しく設定する配列です。この配列は、thisが所有します。
 	 * @param i_clm
+	 * 新しいVectorの列数です。
 	 */
 	public void setNewArray(double[] i_array, int i_clm)
 	{
-- 
2.11.0