From 91f6ac21aa8fad94b3336ba9d79ee38d9c3836de Mon Sep 17 00:00:00 2001 From: Olyutorskii Date: Thu, 4 Jul 2019 01:34:27 +0900 Subject: [PATCH] modify javadoc paragraph. --- .../java/jp/sfjp/mikutoga/pmd/model/PmdModel.java | 24 +++++++++++++++-- .../java/jp/sfjp/mikutoga/pmd/model/Surface.java | 14 ++++++++-- .../java/jp/sfjp/mikutoga/pmd/model/Vertex.java | 21 +++++++++++++-- .../mikutoga/pmd/model/binio/PmdExporterBase.java | 30 +++++++++++++++++++--- .../mikutoga/pmd/model/binio/PmdExporterExt1.java | 11 ++++++-- .../mikutoga/pmd/model/binio/PmdExporterExt2.java | 7 +++-- .../mikutoga/pmd/model/binio/PmdExporterExt3.java | 15 +++++++++-- .../sfjp/mikutoga/pmd/model/binio/PmdLoader.java | 3 +++ .../sfjp/mikutoga/pmd/model/xml/CloseXmlMark.java | 8 +++++- .../sfjp/mikutoga/pmd/model/xml/OpenXmlMark.java | 8 +++++- .../sfjp/mikutoga/pmd/model/xml/Schema101009.java | 2 ++ .../sfjp/mikutoga/pmd/model/xml/Schema130128.java | 2 ++ .../jp/sfjp/mikutoga/pmd/model/xml/XmlHandler.java | 18 +++++++++++-- .../mikutoga/pmd/model/xml/XmlModelFileType.java | 4 +-- .../sfjp/mikutoga/pmd/model/xml/XmlPmdLoader.java | 3 +++ .../java/jp/sfjp/mikutoga/pmd2xml/CmdLine.java | 10 +++++--- .../jp/sfjp/mikutoga/pmd2xml/ModelFileType.java | 6 +++++ .../java/jp/sfjp/mikutoga/pmd2xml/OptInfo.java | 24 ++++++++++++++--- .../java/jp/sfjp/mikutoga/pmd2xml/OptSwitch.java | 22 ++++++++++------ .../java/jp/sfjp/mikutoga/pmd2xml/Pmd2Xml.java | 24 ++++++++++++++++- .../java/jp/sfjp/mikutoga/pmd2xml/Pmd2XmlConv.java | 21 +++++++++++++++ .../jp/sfjp/mikutoga/pmd2xml/XmlInputUtil.java | 13 +++++++--- 22 files changed, 251 insertions(+), 39 deletions(-) diff --git a/src/main/java/jp/sfjp/mikutoga/pmd/model/PmdModel.java b/src/main/java/jp/sfjp/mikutoga/pmd/model/PmdModel.java index d44c89c..cc34259 100644 --- a/src/main/java/jp/sfjp/mikutoga/pmd/model/PmdModel.java +++ b/src/main/java/jp/sfjp/mikutoga/pmd/model/PmdModel.java @@ -70,6 +70,7 @@ public class PmdModel { /** * モデル名を返す。 + * * @return モデル名 */ public I18nText getModelName(){ @@ -79,6 +80,7 @@ public class PmdModel { /** * モデル説明文を返す。 * 改行表現には{@literal \n}が用いられる + * * @return モデル説明文 */ public I18nText getDescription(){ @@ -87,6 +89,7 @@ public class PmdModel { /** * 頂点リストを返す。 + * * @return 頂点リスト。 */ public List getVertexList(){ @@ -95,6 +98,7 @@ public class PmdModel { /** * 面リストを返す。 + * * @return 面リスト */ public List getSurfaceList(){ @@ -103,6 +107,7 @@ public class PmdModel { /** * 素材リストを返す。 + * * @return 素材リスト */ public List getMaterialList(){ @@ -111,6 +116,7 @@ public class PmdModel { /** * ボーンリストを返す。 + * * @return ボーンリスト */ public List getBoneList(){ @@ -119,6 +125,7 @@ public class PmdModel { /** * ボーングループリストを返す。 + * * @return ボーングループリスト */ public List getBoneGroupList(){ @@ -127,6 +134,7 @@ public class PmdModel { /** * IKチェーンリストを返す。 + * * @return IKチェーンリスト */ public List getIKChainList(){ @@ -135,6 +143,7 @@ public class PmdModel { /** * 種類別モーフリストのマップを返す。 + * * @return 種類別モーフリストのマップ */ public Map> getMorphMap(){ @@ -143,6 +152,7 @@ public class PmdModel { /** * 剛体リストを返す。 + * * @return 剛体リスト */ public List getRigidList(){ @@ -151,6 +161,7 @@ public class PmdModel { /** * 剛体グループリストを返す。 + * * @return 剛体グループリスト。 */ public List getRigidGroupList(){ @@ -159,6 +170,7 @@ public class PmdModel { /** * 剛体間ジョイントリストを返す。 + * * @return 剛体間ジョイントリスト */ public List getJointList(){ @@ -167,6 +179,7 @@ public class PmdModel { /** * トゥーンファイルマップを返す。 + * * @return トゥーンファイルマップ */ public ToonMap getToonMap(){ @@ -176,6 +189,7 @@ public class PmdModel { /** * トゥーンファイルマップを設定する。 * 各素材のシェーディングで参照するトゥーンファイルマップも更新される。 + * * @param map トゥーンファイルマップ */ public void setToonMap(ToonMap map){ @@ -190,6 +204,7 @@ public class PmdModel { /** * このモデルがグローバル名を含むか判定する。 * ボーン名、ボーングループ名、モーフ名、モデル説明文が判定対象。 + * * @return グローバル名を持つならtrue */ public boolean hasGlobalText(){ @@ -216,6 +231,7 @@ public class PmdModel { /** * 全モーフが使う全モーフ頂点の出現順リストを返す。 * モーフ種別毎に固まっている事が保証される。 + * * @return モーフ頂点リスト */ private List getAllMorphVertexList(){ @@ -239,6 +255,7 @@ public class PmdModel { /** * 重複する頂点参照を除いたモーフ頂点リストを返す。 + * * @param allList モーフ頂点リスト * @return 重複が除かれたモーフ頂点リスト */ @@ -264,9 +281,10 @@ public class PmdModel { * モーフで使われる全てのモーフ頂点のリストを返す。 * モーフ間で重複する頂点はマージされる。 * 頂点IDでソートされる。 - *

- * 0から始まる通し番号がリナンバリングされる。 + * + *

0から始まる通し番号がリナンバリングされる。 * 通し番号は返されるモーフ頂点リストの添え字番号と一致する。 + * * @return モーフに使われるモーフ頂点のリスト */ public List mergeMorphVertex(){ @@ -319,6 +337,7 @@ public class PmdModel { * 所属マテリアル順に再配置し、通し番号を割り振り直す。 * 所属マテリアルの無い面はリストの末端に配置される。 * 面リスト中のnullは削除され詰められる。 + * * @return トリミングされた面リスト */ private List trimmingSurfaceList(){ @@ -355,6 +374,7 @@ public class PmdModel { * 通し番号を振り直す。 * 所属面の無い頂点はリストの末端に配置される。 * 頂点リスト中のnullは削除され詰められる。 + * * @return トリミングされた頂点リスト */ private List trimmingVertexList(){ diff --git a/src/main/java/jp/sfjp/mikutoga/pmd/model/Surface.java b/src/main/java/jp/sfjp/mikutoga/pmd/model/Surface.java index f3e9ab5..892fbc2 100644 --- a/src/main/java/jp/sfjp/mikutoga/pmd/model/Surface.java +++ b/src/main/java/jp/sfjp/mikutoga/pmd/model/Surface.java @@ -38,6 +38,7 @@ public class Surface implements SerialNumbered, Iterable { /** * 3頂点を設定する。 + * * @param vtx1 頂点1 * @param vtx2 頂点2 * @param vtx3 頂点3 @@ -61,10 +62,11 @@ public class Surface implements SerialNumbered, Iterable { /** * 3頂点を返す。 + * * @param store 頂点格納用配列。nullもしくは3要素に満たない場合は無視され、 - * 新規に格納用配列が生成される。 + * 新規に格納用配列が生成される。 * @return 先頭3要素に3頂点が収められた配列。未設定要素にはnullが入る。 - * 引数が長さ3以上の配列であれば引数と同じ配列が返る。 + * 引数が長さ3以上の配列であれば引数と同じ配列が返る。 */ public Vertex[] getTriangle(Vertex[] store){ Vertex[] result; @@ -83,6 +85,7 @@ public class Surface implements SerialNumbered, Iterable { /** * 頂点その1を返す。 + * * @return 頂点その1 */ public Vertex getVertex1(){ @@ -91,6 +94,7 @@ public class Surface implements SerialNumbered, Iterable { /** * 頂点その2を返す。 + * * @return 頂点その2 */ public Vertex getVertex2(){ @@ -99,6 +103,7 @@ public class Surface implements SerialNumbered, Iterable { /** * 頂点その3を返す。 + * * @return 頂点その3 */ public Vertex getVertex3(){ @@ -109,6 +114,7 @@ public class Surface implements SerialNumbered, Iterable { * {@inheritDoc} * 頂点を返す反復子を生成する。 * 反復子がnullを返す可能性もありうる。 + * * @return {@inheritDoc} */ @Override @@ -124,6 +130,7 @@ public class Surface implements SerialNumbered, Iterable { /** * 3頂点全てが設定されているか判定する。 + * * @return 3頂点とも非nullが設定されていればtrue */ public boolean isCompleted(){ @@ -136,6 +143,7 @@ public class Surface implements SerialNumbered, Iterable { /** * {@inheritDoc} + * * @param num {@inheritDoc} */ @Override @@ -146,6 +154,7 @@ public class Surface implements SerialNumbered, Iterable { /** * {@inheritDoc} + * * @return {@inheritDoc} */ @Override @@ -155,6 +164,7 @@ public class Surface implements SerialNumbered, Iterable { /** * {@inheritDoc} + * * @return {@inheritDoc} */ @Override diff --git a/src/main/java/jp/sfjp/mikutoga/pmd/model/Vertex.java b/src/main/java/jp/sfjp/mikutoga/pmd/model/Vertex.java index b037d88..64437ae 100644 --- a/src/main/java/jp/sfjp/mikutoga/pmd/model/Vertex.java +++ b/src/main/java/jp/sfjp/mikutoga/pmd/model/Vertex.java @@ -47,6 +47,7 @@ public class Vertex implements SerialNumbered { /** * 頂点位置座標を返す。 + * * @return 頂点の位置座標 */ public MkPos3D getPosition(){ @@ -55,6 +56,7 @@ public class Vertex implements SerialNumbered { /** * 法線ベクトルを返す。 + * * @return 法線ベクトル */ public MkVec3D getNormal(){ @@ -63,6 +65,7 @@ public class Vertex implements SerialNumbered { /** * UVマップ座標を返す。 + * * @return UVマップ情報 */ public MkPos2D getUVPosition(){ @@ -71,6 +74,7 @@ public class Vertex implements SerialNumbered { /** * 頂点の属するボーンを設定する。 + * * @param boneAArg ボーンA * @param boneBArg ボーンB * @throws NullPointerException 引数がnull @@ -88,6 +92,7 @@ public class Vertex implements SerialNumbered { /** * ボーンAを返す。 + * * @return ボーンA */ public BoneInfo getBoneA(){ @@ -96,6 +101,7 @@ public class Vertex implements SerialNumbered { /** * ボーンBを返す。 + * * @return ボーンB */ public BoneInfo getBoneB(){ @@ -104,12 +110,13 @@ public class Vertex implements SerialNumbered { /** * ボーンAのウェイト値を設定する。 + * * @param weight ウェイト値。0(影響小)-100(影響大) * @throws IllegalArgumentException ウェイト値が範囲外 */ public void setWeightA(int weight) throws IllegalArgumentException{ - if( weight < MIN_WEIGHT - || MAX_WEIGHT < weight ){ + if( weight < MIN_WEIGHT + || MAX_WEIGHT < weight ){ throw new IllegalArgumentException(); } this.boneWeight = weight; @@ -118,6 +125,7 @@ public class Vertex implements SerialNumbered { /** * ボーンBのウェイト値を設定する。 + * * @param weight ウェイト値。0(影響小)-100(影響大) * @throws IllegalArgumentException ウェイト値が範囲外 */ @@ -128,6 +136,7 @@ public class Vertex implements SerialNumbered { /** * ボーンAのウェイト値を返す。 + * * @return ウェイト値 */ public int getWeightA(){ @@ -136,6 +145,7 @@ public class Vertex implements SerialNumbered { /** * ボーンBのウェイト値を返す。 + * * @return ウェイト値 */ public int getWeightB(){ @@ -145,6 +155,7 @@ public class Vertex implements SerialNumbered { /** * ボーンAのウェイト率を返す。 + * * @return ウェイト率。0.0(影響小)-1.0(影響大) */ public float getWeightRatioA(){ @@ -153,6 +164,7 @@ public class Vertex implements SerialNumbered { /** * ボーンBのウェイト率を返す。 + * * @return ウェイト率。0.0(影響小)-1.0(影響大) */ public float getWeightRatioB(){ @@ -163,6 +175,7 @@ public class Vertex implements SerialNumbered { /** * エッジを表示するか設定する。 * マテリアル材質単位の設定より優先度は高い。 + * * @param show 表示するならtrue */ public void setEdgeAppearance(boolean show){ @@ -173,6 +186,7 @@ public class Vertex implements SerialNumbered { /** * エッジを表示するか判定する。 * マテリアル材質単位の設定より優先度は高い。 + * * @return 表示するならtrue */ public boolean getEdgeAppearance(){ @@ -181,6 +195,7 @@ public class Vertex implements SerialNumbered { /** * {@inheritDoc} + * * @param num {@inheritDoc} */ @Override @@ -191,6 +206,7 @@ public class Vertex implements SerialNumbered { /** * {@inheritDoc} + * * @return {@inheritDoc} */ @Override @@ -200,6 +216,7 @@ public class Vertex implements SerialNumbered { /** * {@inheritDoc} + * * @return {@inheritDoc} */ @Override diff --git a/src/main/java/jp/sfjp/mikutoga/pmd/model/binio/PmdExporterBase.java b/src/main/java/jp/sfjp/mikutoga/pmd/model/binio/PmdExporterBase.java index 5cfe69a..5c60e0f 100644 --- a/src/main/java/jp/sfjp/mikutoga/pmd/model/binio/PmdExporterBase.java +++ b/src/main/java/jp/sfjp/mikutoga/pmd/model/binio/PmdExporterBase.java @@ -38,8 +38,8 @@ import jp.sfjp.mikutoga.pmd.model.Vertex; /** * PMDファイルのエクスポーター(拡張無し基本フォーマット)。 - *

- * 英名対応以降のPMDファイルフォーマットを + * + *

英名対応以降のPMDファイルフォーマットを * 使いたくない場合はこのエクスポーターを用いて出力せよ。 */ public class PmdExporterBase extends BinaryExporter{ @@ -88,6 +88,7 @@ public class PmdExporterBase extends BinaryExporter{ /** * コンストラクタ。 + * * @param stream 出力ストリーム * @throws NullPointerException 引数がnull */ @@ -100,6 +101,7 @@ public class PmdExporterBase extends BinaryExporter{ /** * 改行文字の正規化を行う。 * CR(0x0d)およびCRLF(0x0d0a)がLF(0x0a)へと正規化される。 + * * @param text 文字列 * @return 正規化の行われた文字列。 */ @@ -117,11 +119,12 @@ public class PmdExporterBase extends BinaryExporter{ * 文字列の改行記号はLF(0x0a)に正規化される。 * エンコード結果がバイト長に満たない場合は * 1つの0x00及びそれに続く複数の0xfdがパディングされる。 + * * @param text 文字列 * @param maxByteLength バイト長指定 * @throws IOException 出力エラー * @throws IllegalTextExportException エンコード結果が - * 指定バイト長をはみ出した。 + * 指定バイト長をはみ出した。 */ protected void dumpText(String text, int maxByteLength) throws IOException, IllegalTextExportException{ @@ -131,6 +134,7 @@ public class PmdExporterBase extends BinaryExporter{ /** * モデルデータをPMDファイル形式で出力する。 + * * @param model モデルデータ * @throws IOException 出力エラー * @throws IllegalPmdDataException モデルデータに不備が発見された @@ -156,6 +160,7 @@ public class PmdExporterBase extends BinaryExporter{ /** * モデル基本情報を出力する。 + * * @param model モデルデータ * @throws IOException 出力エラー * @throws IllegalTextExportException モデル名もしくは説明が長すぎる @@ -179,6 +184,7 @@ public class PmdExporterBase extends BinaryExporter{ /** * 頂点リストを出力する。 + * * @param model モデルデータ * @throws IOException 出力エラー */ @@ -200,6 +206,7 @@ public class PmdExporterBase extends BinaryExporter{ /** * 個別の頂点データを出力する。 + * * @param vertex 頂点 * @throws IOException 出力エラー */ @@ -233,6 +240,7 @@ public class PmdExporterBase extends BinaryExporter{ /** * 面リストを出力する。 + * * @param model モデルデータ * @throws IOException 出力エラー */ @@ -262,6 +270,7 @@ public class PmdExporterBase extends BinaryExporter{ /** * マテリアル素材リストを出力する。 + * * @param model モデルデータ * @throws IOException 出力エラー * @throws IllegalTextExportException シェーディングファイル情報が長すぎる @@ -285,6 +294,7 @@ public class PmdExporterBase extends BinaryExporter{ /** * フォンシェーディングの色情報を出力する。 + * * @param material マテリアル情報 * @throws IOException 出力エラー */ @@ -317,6 +327,7 @@ public class PmdExporterBase extends BinaryExporter{ /** * シェーディング情報を出力する。 + * * @param material マテリアル情報 * @throws IOException 出力エラー * @throws IllegalTextExportException ファイル名が長すぎる @@ -343,6 +354,7 @@ public class PmdExporterBase extends BinaryExporter{ /** * シェーディングファイル情報を出力する。 + * * @param shade シェーディング情報 * @throws IOException 出力エラー * @throws IllegalTextExportException ファイル名が長すぎる @@ -372,6 +384,7 @@ public class PmdExporterBase extends BinaryExporter{ /** * ボーンリストを出力する。 + * * @param model モデルデータ * @throws IOException 出力エラー * @throws IllegalTextExportException ボーン名が長すぎる @@ -394,6 +407,7 @@ public class PmdExporterBase extends BinaryExporter{ /** * 個別のボーン情報を出力する。 + * * @param bone ボーン情報 * @throws IOException 出力エラー * @throws IllegalTextExportException ボーン名が長すぎる @@ -431,6 +445,7 @@ public class PmdExporterBase extends BinaryExporter{ /** * IKチェーンリストを出力する。 + * * @param model モデルデータ * @throws IOException 出力エラー */ @@ -452,6 +467,7 @@ public class PmdExporterBase extends BinaryExporter{ /** * IKチェーンを出力する。 + * * @param chain IKチェーン * @throws IOException 出力エラー */ @@ -485,6 +501,7 @@ public class PmdExporterBase extends BinaryExporter{ /** * モーフリストを出力する。 + * * @param model モデルデータ * @throws IOException 出力エラー * @throws IllegalTextExportException モーフ名が長すぎる @@ -533,6 +550,7 @@ public class PmdExporterBase extends BinaryExporter{ /** * BASEモーフを出力する。 + * * @param model モデルデータ * @throws IOException 出力エラー * @throws IllegalTextExportException モーフ名が長すぎる @@ -557,6 +575,7 @@ public class PmdExporterBase extends BinaryExporter{ /** * モーフグループを出力する。 + * * @param model モデルデータ * @throws IOException 出力エラー */ @@ -596,6 +615,7 @@ public class PmdExporterBase extends BinaryExporter{ /** * ボーングループリストを出力する。 * デフォルトボーングループ内訳は出力されない。 + * * @param model モデルデータ * @throws IOException 出力エラー * @throws IllegalTextExportException ボーングループ名が長すぎる @@ -632,6 +652,7 @@ public class PmdExporterBase extends BinaryExporter{ /** * 各種通し番号をshort値で出力する。 * short値に収まらない上位ビットは捨てられる。 + * * @param obj 番号づけられたオブジェクト * @throws IOException 出力エラー */ @@ -644,6 +665,7 @@ public class PmdExporterBase extends BinaryExporter{ /** * 2次元位置情報を出力する。 + * * @param position 2次元位置情報 * @throws IOException 出力エラー */ @@ -659,6 +681,7 @@ public class PmdExporterBase extends BinaryExporter{ /** * 3次元位置情報を出力する。 + * * @param position 3次元位置情報 * @throws IOException 出力エラー */ @@ -676,6 +699,7 @@ public class PmdExporterBase extends BinaryExporter{ /** * 3次元ベクトル情報を出力する。 + * * @param vector 3次元ベクトル * @throws IOException 出力エラー */ diff --git a/src/main/java/jp/sfjp/mikutoga/pmd/model/binio/PmdExporterExt1.java b/src/main/java/jp/sfjp/mikutoga/pmd/model/binio/PmdExporterExt1.java index c5ae1ac..150905d 100644 --- a/src/main/java/jp/sfjp/mikutoga/pmd/model/binio/PmdExporterExt1.java +++ b/src/main/java/jp/sfjp/mikutoga/pmd/model/binio/PmdExporterExt1.java @@ -22,14 +22,15 @@ import jp.sfjp.mikutoga.pmd.model.PmdModel; /** * PMDファイルのエクスポーター(拡張1:英名対応)。 - *

- * 任意のトゥーンファイル名対応以降のPMDファイルフォーマットを + * + *

任意のトゥーンファイル名対応以降のPMDファイルフォーマットを * 使いたくない場合はこのエクスポーターを用いて出力せよ。 */ public class PmdExporterExt1 extends PmdExporterBase{ /** * コンストラクタ。 + * * @param stream 出力ストリーム * @throws NullPointerException 引数がnull */ @@ -41,6 +42,7 @@ public class PmdExporterExt1 extends PmdExporterBase{ /** * {@inheritDoc} + * * @param model {@inheritDoc} * @throws IOException {@inheritDoc} * @throws IllegalPmdDataException {@inheritDoc} @@ -57,6 +59,7 @@ public class PmdExporterExt1 extends PmdExporterBase{ /** * 英語名情報を出力する。 + * * @param model モデルデータ * @throws IOException 出力エラー * @throws IllegalPmdDataException 文字列が長すぎる。 @@ -87,6 +90,7 @@ public class PmdExporterExt1 extends PmdExporterBase{ /** * モデル基本情報を英語で出力する。 + * * @param model モデルデータ * @throws IOException 出力エラー * @throws IllegalTextExportException 文字列が長すぎる。 @@ -106,6 +110,7 @@ public class PmdExporterExt1 extends PmdExporterBase{ /** * ボーン英語名情報を出力する。 + * * @param model モデルデータ * @throws IOException 出力エラー * @throws IllegalTextExportException 文字列が長すぎる。 @@ -123,6 +128,7 @@ public class PmdExporterExt1 extends PmdExporterBase{ /** * モーフ英語名情報を出力する。 + * * @param model モデルデータ * @throws IOException 出力エラー * @throws IllegalTextExportException 文字列が長すぎる。 @@ -147,6 +153,7 @@ public class PmdExporterExt1 extends PmdExporterBase{ /** * ボーングループ英語名情報を出力する。 + * * @param model モデルデータ * @throws IOException 出力エラー * @throws IllegalTextExportException 文字列が長すぎる diff --git a/src/main/java/jp/sfjp/mikutoga/pmd/model/binio/PmdExporterExt2.java b/src/main/java/jp/sfjp/mikutoga/pmd/model/binio/PmdExporterExt2.java index ede02ae..64df86c 100644 --- a/src/main/java/jp/sfjp/mikutoga/pmd/model/binio/PmdExporterExt2.java +++ b/src/main/java/jp/sfjp/mikutoga/pmd/model/binio/PmdExporterExt2.java @@ -17,14 +17,15 @@ import jp.sfjp.mikutoga.pmd.model.ToonMap; /** * PMDファイルのエクスポーター(拡張2:任意のトゥーンファイル名対応)。 - *

- * 物理演算対応以降のPMDファイルフォーマットを + * + *

物理演算対応以降のPMDファイルフォーマットを * 使いたくない場合はこのエクスポーターを用いて出力せよ。 */ public class PmdExporterExt2 extends PmdExporterExt1{ /** * コンストラクタ。 + * * @param stream 出力ストリーム * @throws NullPointerException 引数がnull */ @@ -36,6 +37,7 @@ public class PmdExporterExt2 extends PmdExporterExt1{ /** * {@inheritDoc} + * * @param model {@inheritDoc} * @throws IOException {@inheritDoc} * @throws IllegalPmdDataException {@inheritDoc} @@ -56,6 +58,7 @@ public class PmdExporterExt2 extends PmdExporterExt1{ /** * 独自トゥーンファイルテーブルを出力する。 + * * @param model モデルデータ * @throws IOException 出力エラー * @throws IllegalTextExportException トゥーンファイル名が長すぎる diff --git a/src/main/java/jp/sfjp/mikutoga/pmd/model/binio/PmdExporterExt3.java b/src/main/java/jp/sfjp/mikutoga/pmd/model/binio/PmdExporterExt3.java index 01af3ac..edbfe0a 100644 --- a/src/main/java/jp/sfjp/mikutoga/pmd/model/binio/PmdExporterExt3.java +++ b/src/main/java/jp/sfjp/mikutoga/pmd/model/binio/PmdExporterExt3.java @@ -27,8 +27,8 @@ import jp.sfjp.mikutoga.pmd.model.RigidShape; /** * PMDファイルのエクスポーター(拡張3:物理演算対応)。 - *

- * 物理演算対応のPMDファイルフォーマットを + * + *

物理演算対応のPMDファイルフォーマットを * 使いたい場合はこのエクスポーターを用いて出力せよ。 */ public class PmdExporterExt3 extends PmdExporterExt2{ @@ -37,6 +37,7 @@ public class PmdExporterExt3 extends PmdExporterExt2{ /** * コンストラクタ。 + * * @param stream 出力ストリーム * @throws NullPointerException 引数がnull */ @@ -48,6 +49,7 @@ public class PmdExporterExt3 extends PmdExporterExt2{ /** * {@inheritDoc} + * * @param model {@inheritDoc} * @throws IOException {@inheritDoc} * @throws IllegalPmdDataException {@inheritDoc} @@ -69,6 +71,7 @@ public class PmdExporterExt3 extends PmdExporterExt2{ /** * 剛体リストを出力する。 + * * @param model モデルデータ * @throws IOException 出力エラー * @throws IllegalTextExportException 長すぎる剛体名 @@ -90,6 +93,7 @@ public class PmdExporterExt3 extends PmdExporterExt2{ /** * 個別の剛体情報を出力する。 + * * @param rigid 剛体 * @throws IOException 出力エラー * @throws IllegalTextExportException 長すぎる剛体名 @@ -130,6 +134,7 @@ public class PmdExporterExt3 extends PmdExporterExt2{ /** * 剛体形状を出力する。 + * * @param shape 剛体形状 * @throws IOException 出力エラー */ @@ -151,6 +156,7 @@ public class PmdExporterExt3 extends PmdExporterExt2{ /** * 力学設定を出力する。 + * * @param dynamics 力学設定 * @throws IOException 出力エラー */ @@ -173,6 +179,7 @@ public class PmdExporterExt3 extends PmdExporterExt2{ /** * ジョイントリストを出力する。 + * * @param model モデルデータ * @throws IOException 出力エラー * @throws IllegalTextExportException 長すぎるジョイント名 @@ -194,6 +201,7 @@ public class PmdExporterExt3 extends PmdExporterExt2{ /** * 個別のジョイント情報を出力する。 + * * @param joint ジョイント * @throws IOException 出力エラー * @throws IllegalTextExportException 長すぎるジョイント名 @@ -223,6 +231,7 @@ public class PmdExporterExt3 extends PmdExporterExt2{ /** * 3次元範囲制約を出力する。 + * * @param range 3次元範囲制約 * @throws IOException 出力エラー */ @@ -248,6 +257,7 @@ public class PmdExporterExt3 extends PmdExporterExt2{ /** * ラジアンによる3次元姿勢情報を出力する。 + * * @param rad 3次元姿勢情報 * @throws IOException 出力エラー */ @@ -265,6 +275,7 @@ public class PmdExporterExt3 extends PmdExporterExt2{ /** * 度数法による3次元姿勢情報を出力する。 + * * @param deg 3次元姿勢情報 * @throws IOException 出力エラー */ diff --git a/src/main/java/jp/sfjp/mikutoga/pmd/model/binio/PmdLoader.java b/src/main/java/jp/sfjp/mikutoga/pmd/model/binio/PmdLoader.java index 7c3c561..82645d0 100644 --- a/src/main/java/jp/sfjp/mikutoga/pmd/model/binio/PmdLoader.java +++ b/src/main/java/jp/sfjp/mikutoga/pmd/model/binio/PmdLoader.java @@ -40,8 +40,10 @@ public class PmdLoader { /** * 正常パース時に読み残したデータがあったか判定する。 + * *

MMDでの仕様拡張による * PMDファイルフォーマットの拡張が行われた場合を想定。 + * * @return 読み残したデータがあればtrue * @throws IllegalStateException まだパースを試みていない。 */ @@ -53,6 +55,7 @@ public class PmdLoader { /** * PMDファイルの読み込みを行いモデル情報を返す。 * 1インスタンスにつき一度しかロードできない。 + * * @param source PMDファイル入力ソース * @return モデル情報 * @throws IOException 入力エラー diff --git a/src/main/java/jp/sfjp/mikutoga/pmd/model/xml/CloseXmlMark.java b/src/main/java/jp/sfjp/mikutoga/pmd/model/xml/CloseXmlMark.java index 09a9023..e27878c 100644 --- a/src/main/java/jp/sfjp/mikutoga/pmd/model/xml/CloseXmlMark.java +++ b/src/main/java/jp/sfjp/mikutoga/pmd/model/xml/CloseXmlMark.java @@ -18,6 +18,12 @@ import java.lang.annotation.Target; @Target(ElementType.METHOD) @Retention(RetentionPolicy.RUNTIME) @interface CloseXmlMark { - /** タグ指定。 */ + + /** + * タグ指定。 + * + * @return tag + */ PmdTag value(); + } diff --git a/src/main/java/jp/sfjp/mikutoga/pmd/model/xml/OpenXmlMark.java b/src/main/java/jp/sfjp/mikutoga/pmd/model/xml/OpenXmlMark.java index d5d9a7b..c135d4f 100644 --- a/src/main/java/jp/sfjp/mikutoga/pmd/model/xml/OpenXmlMark.java +++ b/src/main/java/jp/sfjp/mikutoga/pmd/model/xml/OpenXmlMark.java @@ -18,6 +18,12 @@ import java.lang.annotation.Target; @Target(ElementType.METHOD) @Retention(RetentionPolicy.RUNTIME) @interface OpenXmlMark { - /** タグ指定。 */ + + /** + * タグ指定。 + * + * @return tag + */ PmdTag value(); + } diff --git a/src/main/java/jp/sfjp/mikutoga/pmd/model/xml/Schema101009.java b/src/main/java/jp/sfjp/mikutoga/pmd/model/xml/Schema101009.java index e1a8acf..2e00f27 100644 --- a/src/main/java/jp/sfjp/mikutoga/pmd/model/xml/Schema101009.java +++ b/src/main/java/jp/sfjp/mikutoga/pmd/model/xml/Schema101009.java @@ -28,7 +28,9 @@ public final class Schema101009{ public static final String LOCAL_SCHEMA_PMDXML = "resources/pmdxml-101009.xsd"; + /** schema URI. */ public static final URI URI_SCHEMA_PMDXML = URI.create(SCHEMA_PMDXML); + /** local resource URI. */ public static final URI RES_SCHEMA_PMDXML; private static final Class THISCLASS = Schema101009.class; diff --git a/src/main/java/jp/sfjp/mikutoga/pmd/model/xml/Schema130128.java b/src/main/java/jp/sfjp/mikutoga/pmd/model/xml/Schema130128.java index caada11..4214176 100644 --- a/src/main/java/jp/sfjp/mikutoga/pmd/model/xml/Schema130128.java +++ b/src/main/java/jp/sfjp/mikutoga/pmd/model/xml/Schema130128.java @@ -28,7 +28,9 @@ public final class Schema130128{ public static final String LOCAL_SCHEMA_PMDXML = "resources/pmdxml-130128.xsd"; + /** schema URI. */ public static final URI URI_SCHEMA_PMDXML = URI.create(SCHEMA_PMDXML); + /** local resource URI. */ public static final URI RES_SCHEMA_PMDXML; private static final Class THISCLASS = Schema130128.class; diff --git a/src/main/java/jp/sfjp/mikutoga/pmd/model/xml/XmlHandler.java b/src/main/java/jp/sfjp/mikutoga/pmd/model/xml/XmlHandler.java index f8db09c..b5d28e2 100644 --- a/src/main/java/jp/sfjp/mikutoga/pmd/model/xml/XmlHandler.java +++ b/src/main/java/jp/sfjp/mikutoga/pmd/model/xml/XmlHandler.java @@ -17,6 +17,7 @@ import org.xml.sax.SAXException; /** * XMLモデルファイルパース用SAXハンドラ。 + * *

下位リスナに各種通知が振り分けられる。 */ class XmlHandler implements ContentHandler{ @@ -58,6 +59,7 @@ class XmlHandler implements ContentHandler{ /** * ビルド対象のモデルを返す。 + * * @return ビルド対象のモデル。ビルド前ならnull */ PmdModel getPmdModel(){ @@ -66,6 +68,7 @@ class XmlHandler implements ContentHandler{ /** * {@inheritDoc} + * * @throws SAXException {@inheritDoc} */ @Override @@ -81,6 +84,7 @@ class XmlHandler implements ContentHandler{ /** * {@inheritDoc} + * * @throws SAXException {@inheritDoc} */ @Override @@ -92,6 +96,7 @@ class XmlHandler implements ContentHandler{ /** * {@inheritDoc} + * * @param prefix {@inheritDoc} * @param uri {@inheritDoc} * @throws SAXException {@inheritDoc} @@ -99,8 +104,8 @@ class XmlHandler implements ContentHandler{ @Override public void startPrefixMapping(String prefix, String uri) throws SAXException { - if( Schema101009.NS_PMDXML.equals(uri) - || Schema130128.NS_PMDXML.equals(uri) ){ + if( Schema101009.NS_PMDXML.equals(uri) + || Schema130128.NS_PMDXML.equals(uri) ){ this.nspfx = prefix; this.nsuri = uri; } @@ -109,6 +114,7 @@ class XmlHandler implements ContentHandler{ /** * {@inheritDoc} + * * @param prefix {@inheritDoc} * @throws SAXException {@inheritDoc} */ @@ -123,6 +129,7 @@ class XmlHandler implements ContentHandler{ /** * {@inheritDoc} + * * @param uri {@inheritDoc} * @param localName {@inheritDoc} * @param qName {@inheritDoc} @@ -150,6 +157,7 @@ class XmlHandler implements ContentHandler{ /** * タグ出現に従い通知リスナを切り替える。 + * * @param tag タグ種別 */ private void switchListener(PmdTag tag){ @@ -163,6 +171,7 @@ class XmlHandler implements ContentHandler{ /** * {@inheritDoc} + * * @param uri {@inheritDoc} * @param localName {@inheritDoc} * @param qName {@inheritDoc} @@ -185,6 +194,7 @@ class XmlHandler implements ContentHandler{ /** * {@inheritDoc} + * * @param locator {@inheritDoc} */ @Override @@ -195,6 +205,7 @@ class XmlHandler implements ContentHandler{ /** * {@inheritDoc} + * * @param target {@inheritDoc} * @param data {@inheritDoc} * @throws SAXException {@inheritDoc} @@ -208,6 +219,7 @@ class XmlHandler implements ContentHandler{ /** * {@inheritDoc} + * * @param ch {@inheritDoc} * @param start {@inheritDoc} * @param length {@inheritDoc} @@ -223,6 +235,7 @@ class XmlHandler implements ContentHandler{ /** * {@inheritDoc} + * * @param ch {@inheritDoc} * @param start {@inheritDoc} * @param length {@inheritDoc} @@ -237,6 +250,7 @@ class XmlHandler implements ContentHandler{ /** * {@inheritDoc} + * * @param name {@inheritDoc} * @throws SAXException {@inheritDoc} */ diff --git a/src/main/java/jp/sfjp/mikutoga/pmd/model/xml/XmlModelFileType.java b/src/main/java/jp/sfjp/mikutoga/pmd/model/xml/XmlModelFileType.java index 555b283..19f0a3a 100644 --- a/src/main/java/jp/sfjp/mikutoga/pmd/model/xml/XmlModelFileType.java +++ b/src/main/java/jp/sfjp/mikutoga/pmd/model/xml/XmlModelFileType.java @@ -14,8 +14,8 @@ public enum XmlModelFileType { /** * XMLファイル。 - *

読み込み時のスキーマ判別は自動。 - * 出力時のスキーマ種別は最新。 + * + *

読み込み時のスキーマ判別は自動。出力時のスキーマ種別は最新。 */ XML_AUTO, diff --git a/src/main/java/jp/sfjp/mikutoga/pmd/model/xml/XmlPmdLoader.java b/src/main/java/jp/sfjp/mikutoga/pmd/model/xml/XmlPmdLoader.java index c7a3411..3bd0a26 100644 --- a/src/main/java/jp/sfjp/mikutoga/pmd/model/xml/XmlPmdLoader.java +++ b/src/main/java/jp/sfjp/mikutoga/pmd/model/xml/XmlPmdLoader.java @@ -27,7 +27,9 @@ public class XmlPmdLoader { /** * コンストラクタ。 + * *

XMLリーダは名前空間をサポートしていなければならない。 + * * @param reader XMLリーダ * @throws NullPointerException 引数がnull * @throws SAXException 機能不足のXMLリーダが渡された @@ -49,6 +51,7 @@ public class XmlPmdLoader { /** * XMLのパースを開始する。 + * * @param source XML入力 * @return モデルデータ * @throws SAXException 構文エラー diff --git a/src/main/java/jp/sfjp/mikutoga/pmd2xml/CmdLine.java b/src/main/java/jp/sfjp/mikutoga/pmd2xml/CmdLine.java index 900a7f2..f98a6ee 100644 --- a/src/main/java/jp/sfjp/mikutoga/pmd2xml/CmdLine.java +++ b/src/main/java/jp/sfjp/mikutoga/pmd2xml/CmdLine.java @@ -33,6 +33,7 @@ final class CmdLine { /** * コマンドライン解析を行う。 + * * @param args コマンドライン * @return 解析されたコマンドライン並び */ @@ -43,6 +44,7 @@ final class CmdLine { /** * コマンドライン解析を行う。 + * * @param argList コマンドライン * @return 解析されたコマンドライン並び */ @@ -81,8 +83,9 @@ final class CmdLine { /** * オプション識別子を返す。 + * * @return オプション識別子。 - * オプションを伴わない単純なコマンドライン引数の場合はnullを返す。 + * オプションを伴わない単純なコマンドライン引数の場合はnullを返す。 */ OptSwitch getOptSwitch() { return this.opt; @@ -90,9 +93,10 @@ final class CmdLine { /** * オプションに付随する引数群を返す。 + * * @return オプションに付随する引数群。 - * 先頭要素はオプション識別子。 - * 単純なコマンドライン引数の場合は自身が1要素のみを占める。 + * 先頭要素はオプション識別子。 + * 単純なコマンドライン引数の場合は自身が1要素のみを占める。 */ List getOptArgs() { return this.optArgs; diff --git a/src/main/java/jp/sfjp/mikutoga/pmd2xml/ModelFileType.java b/src/main/java/jp/sfjp/mikutoga/pmd2xml/ModelFileType.java index 9375b97..d474e3b 100644 --- a/src/main/java/jp/sfjp/mikutoga/pmd2xml/ModelFileType.java +++ b/src/main/java/jp/sfjp/mikutoga/pmd2xml/ModelFileType.java @@ -26,7 +26,9 @@ public enum ModelFileType { /** * XMLファイル。 + * *

読み込み時のスキーマ判別は自動。 + * *

書き込み時のスキーマは最新。 */ XML_AUTO, @@ -57,7 +59,9 @@ public enum ModelFileType { /** * ファイル種別をXMLファイル種別に変換する。 + * *

未定義の場合はXML_AUTOを返す。 + * * @return XMLファイル種別 */ public XmlModelFileType toXmlType(){ @@ -83,6 +87,7 @@ public enum ModelFileType { /** * ファイル種別がXMLか判定する。 + * * @return XMLならtrue */ public boolean isXml(){ @@ -104,6 +109,7 @@ public enum ModelFileType { /** * ファイル種別がPMDか判定する。 + * * @return PMDならtrue */ public boolean isPmd(){ diff --git a/src/main/java/jp/sfjp/mikutoga/pmd2xml/OptInfo.java b/src/main/java/jp/sfjp/mikutoga/pmd2xml/OptInfo.java index 9fc99b0..17d4edd 100644 --- a/src/main/java/jp/sfjp/mikutoga/pmd2xml/OptInfo.java +++ b/src/main/java/jp/sfjp/mikutoga/pmd2xml/OptInfo.java @@ -73,6 +73,7 @@ final class OptInfo { /** * フォーマット種別指定子をデコードする。 + * * @param arg 文字列 * @return デコード結果。 * @throws CmdLineException 不正なフォーマット種別 @@ -99,6 +100,7 @@ final class OptInfo { /** * 改行文字指定子をデコードする。 + * * @param arg 文字列 * @return デコード結果。 * @throws CmdLineException 不正なフォーマット種別 @@ -121,6 +123,7 @@ final class OptInfo { /** * ブール指定子をデコードする。 + * * @param arg 文字列 * @return デコード結果。 * @throws CmdLineException 不正なフォーマット種別 @@ -129,9 +132,9 @@ final class OptInfo { throws CmdLineException{ boolean result; - if( "on" .equals(arg) - || "true".equals(arg) - || "yes" .equals(arg) ){ + if( "on" .equals(arg) + || "true".equals(arg) + || "yes" .equals(arg) ){ result = true; }else if( "off" .equals(arg) || "false".equals(arg) @@ -147,7 +150,9 @@ final class OptInfo { /** * ファイル名からファイル種別を類推する。 + * *

拡張子が「pmd」ならPMDファイル、「xml」ならXMLファイル。 + * * @param fileName ファイル名 * @return ファイル種別 */ @@ -164,6 +169,7 @@ final class OptInfo { /** * コマンドラインを解析する。 + * * @param args コマンドライン * @return オプション情報 * @throws CmdLineException 不正なコマンドライン @@ -233,7 +239,9 @@ final class OptInfo { /** * 単純なコマンドラインエラーを検出する。 + * *

検出項目は未知のオプションおよび不正な引数の個数 + * * @param cmdLines コマンドライン * @throws CmdLineException 異常系 */ @@ -266,6 +274,7 @@ final class OptInfo { /** * ファイルフォーマット情報の推測を行う。 + * * @param result オプション情報 */ private static void fixFormat(OptInfo result){ @@ -282,6 +291,7 @@ final class OptInfo { /** * オプション整合性の事後検査。 + * * @param result オプション情報 * @throws CmdLineException 不正なオプション設定 */ @@ -309,6 +319,7 @@ final class OptInfo { /** * ヘルプ表示が必要か否か判定する。 + * * @return 必要ならtrue */ boolean needHelp(){ @@ -317,6 +328,7 @@ final class OptInfo { /** * 入力ファイル種別を返す。 + * * @return 入力ファイル種別 */ ModelFileType getInFileType(){ @@ -325,6 +337,7 @@ final class OptInfo { /** * 出力ファイル種別を返す。 + * * @return 出力ファイル種別 */ ModelFileType getOutFileType(){ @@ -333,6 +346,7 @@ final class OptInfo { /** * 入力ファイル名を返す。 + * * @return 入力ファイル名 */ String getInFilename(){ @@ -341,6 +355,7 @@ final class OptInfo { /** * 出力ファイル名を返す。 + * * @return 出力ファイル名 */ String getOutFilename(){ @@ -349,6 +364,7 @@ final class OptInfo { /** * 上書きモードか否か返す。 + * * @return 上書きモードならtrue */ boolean overwriteMode(){ @@ -357,6 +373,7 @@ final class OptInfo { /** * XML改行文字を返す。 + * * @return 改行文字 */ String getNewline(){ @@ -365,6 +382,7 @@ final class OptInfo { /** * ジェネレータ名を返す。 + * * @return ジェネレータ名。表示したくない時はnull */ String getGenerator(){ diff --git a/src/main/java/jp/sfjp/mikutoga/pmd2xml/OptSwitch.java b/src/main/java/jp/sfjp/mikutoga/pmd2xml/OptSwitch.java index 46aad83..bc4ab7b 100644 --- a/src/main/java/jp/sfjp/mikutoga/pmd2xml/OptSwitch.java +++ b/src/main/java/jp/sfjp/mikutoga/pmd2xml/OptSwitch.java @@ -18,14 +18,14 @@ import java.util.Map; */ enum OptSwitch { - OPT_HELP (0, "-h", "-help", "-?"), - OPT_INFILE (1, "-i"), - OPT_OUTFILE (1, "-o"), - OPT_FORCE (0, "-f"), - OPT_NEWLINE (1, "-nl"), - OPT_GENOUT (1, "-genout"), - OPT_IFORM (1, "-iform"), - OPT_OFORM (1, "-oform"), + OPT_HELP( 0, "-h", "-help", "-?"), + OPT_INFILE( 1, "-i"), + OPT_OUTFILE( 1, "-o"), + OPT_FORCE( 0, "-f"), + OPT_NEWLINE( 1, "-nl"), + OPT_GENOUT( 1, "-genout"), + OPT_IFORM( 1, "-iform"), + OPT_OFORM( 1, "-oform"), ; private static final String HELP_CONSOLE = @@ -69,6 +69,7 @@ enum OptSwitch { /** * コンストラクタ。 + * * @param argnum 必要な引数の数 * @param cmdopts オプションスイッチパターン群 */ @@ -86,6 +87,7 @@ enum OptSwitch { /** * コンソール提示用ヘルプ出力文字列を返す。 + * * @return オプションヘルプ文字列 */ static String getConsoleHelp(){ @@ -94,7 +96,9 @@ enum OptSwitch { /** * 文字列に合致するオプションを返す。 + * *

一つのオプションが複数の表記に合致する場合がある。 + * * @param cmd 文字列 * @return オプション種別。合致する物が見つからなければnull */ @@ -106,7 +110,9 @@ enum OptSwitch { /** * 各オプションに後続する引数の数を返す。 + * *

引数をとらないオプションは0を返す。 + * * @return 引数の数 */ int getExArgNum(){ diff --git a/src/main/java/jp/sfjp/mikutoga/pmd2xml/Pmd2Xml.java b/src/main/java/jp/sfjp/mikutoga/pmd2xml/Pmd2Xml.java index 05ba75d..374dc0b 100644 --- a/src/main/java/jp/sfjp/mikutoga/pmd2xml/Pmd2Xml.java +++ b/src/main/java/jp/sfjp/mikutoga/pmd2xml/Pmd2Xml.java @@ -110,6 +110,7 @@ public final class Pmd2Xml { /** * VMを終了させる。 + * * @param code 終了コード * @see java.lang.System#exit(int) */ @@ -121,6 +122,7 @@ public final class Pmd2Xml { /** * 共通エラーメッセージを出力する。 + * * @param text 個別メッセージ */ private static void errMsg(String text){ @@ -131,6 +133,7 @@ public final class Pmd2Xml { /** * 標準エラー出力へ例外情報出力。 + * * @param ex 例外 * @param dumpStack スタックトレースを出力するならtrue */ @@ -147,6 +150,7 @@ public final class Pmd2Xml { /** * 標準エラー出力へ例外情報出力。 + * * @param ex 例外 */ private static void thPrintln(Throwable ex){ @@ -157,6 +161,7 @@ public final class Pmd2Xml { /** * 入出力エラー処理。 * 例外を出力してVM終了する。 + * * @param ex 例外 */ private static void ioError(IOException ex){ @@ -167,6 +172,7 @@ public final class Pmd2Xml { /** * XML構文エラー処理。 * 例外を出力してVM終了する。 + * * @param ex 例外 */ private static void xmlError(Throwable ex){ @@ -177,6 +183,7 @@ public final class Pmd2Xml { /** * PMDファイルフォーマットエラー処理。 * 例外を出力してVM終了する。 + * * @param ex 例外 */ private static void pmdError(MmdFormatException ex){ @@ -187,6 +194,7 @@ public final class Pmd2Xml { /** * 内部エラー処理。 * 例外を出力してVM終了する。 + * * @param ex 例外 */ private static void internalError(Throwable ex){ @@ -222,8 +230,11 @@ public final class Pmd2Xml { /** * ファイルサイズを0に切り詰める。 + * *

ファイルが存在しなければなにもしない。 + * *

通常ファイルでなければなにもしない。 + * * @param file ファイル * @throws IOException 入出力エラー */ @@ -250,7 +261,9 @@ public final class Pmd2Xml { /** * 入力ソースを準備する。 + * *

入力ファイルが通常ファイルとして存在しなければエラー終了。 + * * @param optInfo オプション情報 * @return 入力ソース */ @@ -272,8 +285,11 @@ public final class Pmd2Xml { /** * 出力ストリームを準備する。 + * *

出力ファイルが通常ファイルでない場合はエラー終了。 + * *

既存の出力ファイルに上書き指示が伴っていなければエラー終了。 + * * @param optInfo オプション情報 * @return 出力ストリーム */ @@ -318,13 +334,14 @@ public final class Pmd2Xml { /** * オプション情報に従いコンバータを生成する。 + * * @param optInfo オプション情報 * @return コンバータ */ private static Pmd2XmlConv buildConverter(OptInfo optInfo){ Pmd2XmlConv converter = new Pmd2XmlConv(); - converter.setInType (optInfo.getInFileType()); + converter.setInType( optInfo.getInFileType()); converter.setOutType(optInfo.getOutFileType()); converter.setNewline(optInfo.getNewline()); @@ -335,7 +352,9 @@ public final class Pmd2Xml { /** * 実際のコンバート作業と異常系処理を行う。 + * *

異常系が起きた場合、このメソッドは制御を戻さない。 + * * @param converter コンバータ * @param source 入力ソース * @param ostream 出力ストリーム @@ -362,7 +381,9 @@ public final class Pmd2Xml { /** * コマンドライン文字列をオプション情報としてパースする。 + * *

異常系が起きた場合、このメソッドは制御を戻さない。 + * * @param args コマンドライン文字列群 * @return オプション情報 */ @@ -385,6 +406,7 @@ public final class Pmd2Xml { /** * Mainエントリ。 + * * @param args コマンドパラメータ */ public static void main(String[] args){ diff --git a/src/main/java/jp/sfjp/mikutoga/pmd2xml/Pmd2XmlConv.java b/src/main/java/jp/sfjp/mikutoga/pmd2xml/Pmd2XmlConv.java index 1b222f2..041c9e5 100644 --- a/src/main/java/jp/sfjp/mikutoga/pmd2xml/Pmd2XmlConv.java +++ b/src/main/java/jp/sfjp/mikutoga/pmd2xml/Pmd2XmlConv.java @@ -53,6 +53,7 @@ public class Pmd2XmlConv { /** * 入力ファイル種別を設定する。 + * * @param type ファイル種別 * @throws NullPointerException 引数がnull * @throws IllegalArgumentException 具体的な種別を渡さなかった @@ -67,6 +68,7 @@ public class Pmd2XmlConv { /** * 入力ファイル種別を返す。 + * * @return ファイル種別 */ public ModelFileType getInTypes(){ @@ -75,6 +77,7 @@ public class Pmd2XmlConv { /** * 出力ファイル種別を設定する。 + * * @param type ファイル種別 * @throws NullPointerException 引数がnull * @throws IllegalArgumentException 具体的な種別を渡さなかった @@ -89,6 +92,7 @@ public class Pmd2XmlConv { /** * 出力ファイル種別を返す。 + * * @return ファイル種別 */ public ModelFileType getOutTypes(){ @@ -97,6 +101,7 @@ public class Pmd2XmlConv { /** * XML出力用改行文字列を設定する。 + * * @param newline 改行文字 */ public void setNewline(String newline){ @@ -106,6 +111,7 @@ public class Pmd2XmlConv { /** * XML出力用改行文字列を返す。 + * * @return 改行文字 */ public String getNewline(){ @@ -114,6 +120,7 @@ public class Pmd2XmlConv { /** * ジェネレータ名を設定する。 + * * @param generator ジェネレータ名。表示したくない場合はnull */ public void setGenerator(String generator){ @@ -123,6 +130,7 @@ public class Pmd2XmlConv { /** * ジェネレータ名を返す。 + * * @return ジェネレータ名。非表示の場合はnullを返す。 */ public String getGenerator(){ @@ -131,8 +139,10 @@ public class Pmd2XmlConv { /** * ファイル変換を行う。 + * *

XML入力の場合は{@link #convert(InputSource, OutputStream)}を * 推奨する。 + * * @param is 入力ストリーム * @param os 出力ストリーム * @throws IOException 入力エラー @@ -154,10 +164,13 @@ public class Pmd2XmlConv { /** * ファイル変換を行う。 + * *

PMD入力の場合は{@link InputStream}に * バイトストリームが直接設定されていなければならない。 + * *

XML入力の場合は{@link InputStream}に * URL(systemId)のみの設定を推奨する。 + * * @param source 入力ソース * @param os 出力ストリーム * @throws IOException 入力エラー @@ -179,8 +192,10 @@ public class Pmd2XmlConv { /** * モデルファイルを読み込む。 + * *

XML読み込みの場合は、 * こちらより{@link #readModel(InputSource)}版を推奨する。 + * * @param is 入力ストリーム * @return モデルデータ * @throws IOException 入力エラー @@ -208,6 +223,7 @@ public class Pmd2XmlConv { /** * モデルファイルを読み込む。 + * * @param source 入力ソース * @return モデルデータ * @throws IOException 入力エラー @@ -240,6 +256,7 @@ public class Pmd2XmlConv { /** * モデルファイルを出力する。 + * * @param model モデルデータ * @param os 出力ストリーム * @throws IOException 出力エラー @@ -261,6 +278,7 @@ public class Pmd2XmlConv { /** * PMDファイルからモデルデータを読み込む。 + * * @param is 入力ストリーム * @return モデルデータ * @throws IOException 入力エラー @@ -275,6 +293,7 @@ public class Pmd2XmlConv { /** * XMLファイルからモデルデータを読み込む。 + * * @param source 入力ソース * @return モデルデータ * @throws IOException 入力エラー @@ -293,6 +312,7 @@ public class Pmd2XmlConv { /** * モデルデータをPMDファイルに出力する。 + * * @param model モデルデータ * @param ostream 出力ストリーム * @throws IOException 出力エラー @@ -308,6 +328,7 @@ public class Pmd2XmlConv { /** * モデルデータをXMLファイルに出力する。 + * * @param model モデルデータ * @param ostream 出力ストリーム * @throws IOException 出力エラー diff --git a/src/main/java/jp/sfjp/mikutoga/pmd2xml/XmlInputUtil.java b/src/main/java/jp/sfjp/mikutoga/pmd2xml/XmlInputUtil.java index 8d5f989..d17c406 100644 --- a/src/main/java/jp/sfjp/mikutoga/pmd2xml/XmlInputUtil.java +++ b/src/main/java/jp/sfjp/mikutoga/pmd2xml/XmlInputUtil.java @@ -56,6 +56,7 @@ final class XmlInputUtil { /** * 実在ファイルからXML入力ソースを得る。 + * * @param file 実在ファイル * @return XML入力ソース */ @@ -82,8 +83,10 @@ final class XmlInputUtil { /** * InputSourceからInputStreamを得る。 + * *

入力ソースには、少なくともバイトストリームか * URL文字列(SystemId)のいずれかが設定されていなければならない。 + * * @param source 入力ソース * @return 入力バイトストリーム * @throws IllegalArgumentException 入力ソースの設定が足りない。 @@ -110,11 +113,13 @@ final class XmlInputUtil { /** * SAXパーサファクトリを生成する。 + * *

    *
  • XML名前空間機能は有効になる。 *
  • DTDによる形式検証は無効となる。 *
  • XIncludeによる差し込み機能は無効となる。 *
+ * * @param schema スキーマ * @return ファクトリ */ @@ -133,8 +138,7 @@ final class XmlInputUtil { factory.setFeature(F_LOAD_EXTERNAL_DTD, false); }catch( ParserConfigurationException | SAXNotRecognizedException - | SAXNotSupportedException e - ){ + | SAXNotSupportedException e ){ assert false; throw new AssertionError(e); } @@ -146,6 +150,7 @@ final class XmlInputUtil { /** * SAXパーサを生成する。 + * * @param schema スキーマ * @return SAXパーサ */ @@ -173,7 +178,7 @@ final class XmlInputUtil { /** * スキーマを生成する。 - * @param resolver リゾルバ + * * @param xmlInType 入力XML種別 * @return スキーマ */ @@ -213,7 +218,9 @@ final class XmlInputUtil { /** * XMLリーダを生成する。 + * *

エラーハンドラには{@link BotherHandler}が指定される。 + * * @param xmlInType 入力XML種別 * @return XMLリーダ */ -- 2.11.0