オブジェクト、配列などのデータの内容をダンプする機能を提供します。
オブジェクト、配列などのデータの内容をダンプする機能を提供します。
この名前空間をテンプレートから使用する場合、以下のようにテンプレート自身でjsファイルをロードしておく必要があります。
IO.include("frame/Dumper.js");
ファイルパスを操作するための機能を提供するクラス。
ファイルパスを操作するための機能を提供するクラス。
ハッシュテーブルを表現するクラス
継承関係 |
Hash
|
サンプル | 1 var _index = new Hash();
2 _index.set("a", "apple");
3 _index.set("b", "blue");
4 _index.set("c", "coffee");
5
6 for (var p = _index.first(); p; p = _index.next()) {
7 print(p.key+" is for "+p.value);
8 } ≫プレインテキストvar _index = new Hash();
_index.set("a", "apple");
_index.set("b", "blue");
_index.set("c", "coffee");
for (var p = _index.first(); p; p = _index.next()) {
print(p.key+" is for "+p.value);
} ≫ハイライト |
定義 | Hash.js |
ファイルの読み書きを実行するメソッドのコレクションです。
ファイルの読み書きを実行するメソッドのコレクションです。
JsDoc Toolkitアプリケーションの中核となるオブジェクト群を内包する名前空間です。
JsDoc Toolkitアプリケーションの中核となるオブジェクト群を内包する名前空間です。
DocTagオブジェクトはドックコメント内のタグをパースした結果をプロパティに保持しています。
コンストラクタ内でソースコードのパース処理を実行するクラスです。
コンストラクタ内でソースコードのパース処理を実行するクラスです。
テンプレートの実行時点では、いくつかの静的プロパティを参照するためにだけ使用します。
名前空間 | JSDOC |
継承関係 |
JSDOC.JsDoc
|
バージョン | $Id: JsDoc.js 773 2009-01-24 09:42:04Z micmath $ |
定義 | JsDoc.js |
JsPlateクラスはテンプレートファイルにシンボルオブジェクトなどのデータを適用し、整形されたドキュメントを生成します。
JsPlateクラスはテンプレートファイルにシンボルオブジェクトなどのデータを適用し、整形されたドキュメントを生成します。
JavaScriptの言語仕様に関する情報を取得するために使用する名前空間です。
JavaScriptの言語仕様に関する情報を取得するために使用する名前空間です。
プラグインの登録とイベントに関する機能を管理する名前空間。
プラグインの登録とイベントに関する機能を管理する名前空間。
SymbolSetはSymbolオブジェクトのコレクションクラスです。
SymbolSetはSymbolオブジェクトのコレクションクラスです。
通常JsDoc Toolkitによって1つだけインスタンスが作成され、publish.js内の publish 関数は引数としてそのインスタンスを受け取ります。
LinkクラスはシンボルやファイルへのHTMLリンク(<a>タグ)を作成する機能を提供します。
LinkクラスはシンボルやファイルへのHTMLリンク(<a>タグ)を作成する機能を提供します。
Linkオブジェクトのメソッドのほとんどは自分自身への参照を返すため、以下のようにリンクの設定処理をチェーンした後、
最終的に
toStringメソッドでタグ文字列を出力するのが標準的な使用方法です。
new Link().toSymbol("MySymbol").withText("マイシンボル").target("_blank").toString();
上の処理は次のようなHTMLテキストを出力します。(シンボルの出力先設定は標準テンプレートと同一と仮定)
<a href="./symbols/MySymbol.html" target="_blank" >マイシンボル</a>
注意:
Linkオブジェクトを正常に動作させるには、テンプレートのpublish関数にconfプロパティが存在していなくてはなりません。
実行中のスクリプトからのログメッセージの出力に関する機能を提供します。
実行中のスクリプトからのログメッセージの出力に関する機能を提供します。
Additions to the core string object.
Additions to the core string object.
様々なシステム情報をプロパティに持つ名前空間。特に
SYS.pwdプロパティはテンプレート開発者にとって重要です。
様々なシステム情報をプロパティに持つ名前空間。特に
SYS.pwdプロパティはテンプレート開発者にとって重要です。