このドキュメントは、JsDoc Toolkitのソースコード内で
テンプレート開発者にとって有用と思われるAPIを抜粋し、JsDoc Toolkit自身によってリファレンスドキュメントとして出力したものです。
使用したソースコードのバージョンは2.3.2です。
JsDoc ToolkitはJavaDocのJavaScript版とも言えるドキュメンテーションツールで、ソースコード内に記述された注釈コメントを元にAPIリファレンスを自動生成します。 詳細は公式サイトを参照してください。
ソースコード本体のJavaScriptは原則としてオリジナルのままですが、コメントの大部分はこのドキュメントの作成者であるaiaswoodが追記したものです。
(ソースコードに記述されていたオリジナルのコメントは、グレーの斜体で出力されています。)
このためAPIの説明は原作成者の意図と完全には一致していない可能性があります。
また説明の誤りに関してドキュメント作成者は一切の責任を負いません。
JsDoc Tookitの著作権は、原作成者であるMichael Mathewsに帰属します。
下記のライセンス条項をお読みください。
-------------------------------------------------------------------------- All code specific to JsDoc Toolkit are free, open source and licensed for use under the X11/MIT License. JsDoc Toolkit is Copyright (c)2009 Michael MathewsThis program is free software; you can redistribute it and/or modify it under the terms below. Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice must be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. --------------------------------------------------------------------------
作成者 | aiaswood <http://www12.atwiki.jp/aias-jsdoctoolkit/> |
---|---|
バージョン | 1.0 |
名前空間 |
オブジェクト、配列などのデータの内容をダンプする機能を提供します。
ファイルの読み書きを実行するメソッドのコレクションです。
JsDoc Toolkitアプリケーションの中核となるオブジェクト群を内包する名前空間です。
JavaScriptの言語仕様に関する情報を取得するために使用する名前空間です。
プラグインの登録とイベントに関する機能を管理する名前空間。
実行中のスクリプトからのログメッセージの出力に関する機能を提供します。
様々なシステム情報をプロパティに持つ名前空間。特にSYS.pwdプロパティはテンプレート開発者にとって重要です。
|
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)