JsPlateクラスはテンプレートファイルにシンボルオブジェクトなどのデータを適用し、整形されたドキュメントを生成します。
名前空間JSDOC
継承関係 JSDOC.JsPlate
定義JsPlate.js
他のクラスから継承したメンバを折りたたむ
プライベートメンバを隠す
概要
 コンストラクタ | 定数 | プロパティ | メソッド | イベント | 詳細トップ | ページトップ
コンストラクタ ↑
 
JSDOC.JsPlate(templateFile)
新しいJSDOC.JsPlateオブジェクトを作成する。
プロパティ ↑
String
templateFile
テンプレートファイルのパス
メソッド ↑
<static>
String[]
JSDOC.JsPlate.keys(obj)
配列のキー（インデックス）またはオブジェクトのプロパティ名の配列を返します。
String
process(data [, compact])
テンプレートにデータを渡し、生成されたドキュメント文字列を返します。
String
toCode()
パース済みのテンプレートコードを返します。
<static>
*[]
JSDOC.JsPlate.values(obj)
配列の要素またはオブジェクトのプロパティ値の配列を返します。
詳細
 コンストラクタ | 定数 | プロパティ | メソッド | イベント | 概要トップ | ページトップ
コンストラクタ ↑
JSDOC.JsPlate(templateFile)
↑
新しいJSDOC.JsPlateオブジェクトを作成する。
引数
String templateFile テンプレートファイルのパス
プロパティ ↑
String templateFile
↑
テンプレートファイルのパス
メソッド ↑
<static> String[] JSDOC.JsPlate.keys(obj)
↑
配列のキー（インデックス）またはオブジェクトのプロパティ名の配列を返します。
引数
*[] | Object obj 処理対象の配列またはオブジェクト
戻り値
String[] 配列のキー（インデックス）またはオブジェクトのプロパティ名の配列
String process(data [, compact])
↑
テンプレートにデータを渡し、生成されたドキュメント文字列を返します。
引数
Object data テンプレートに渡されるデータ
Boolean [compact=false] trueとすると、テンプレートから改行と空白を削除して出力します。
戻り値
String 生成されたドキュメントコンテンツ
String toCode()
↑
パース済みのテンプレートコードを返します。
戻り値
String パース済みのテンプレートコード
<static> *[] JSDOC.JsPlate.values(obj)
↑
配列の要素またはオブジェクトのプロパティ値の配列を返します。
引数
*[] | Object obj 処理対象の配列またはオブジェクト
戻り値
*[] 配列の要素またはオブジェクトのプロパティ値の配列
Documentation generated by JsDoc Toolkit 2.3.2 (template:aias-frame 1.6.1) on Mon Apr 05 2010 22:07:31 GMT+0900 (JST)