SymbolSetはSymbolオブジェクトのコレクションクラスです。
通常JsDoc Toolkitによって1つだけインスタンスが作成され、publish.js内の publish 関数は引数としてそのインスタンスを受け取ります。
| 名前空間 | JSDOC |
|---|---|
| 継承関係 | JSDOC.SymbolSet |
| 定義 | SymbolSet.js |
他のクラスから継承したメンバを折りたたむ
プライベートメンバを隠す
プライベートメンバを隠す
概要 | コンストラクタ | 定数 | プロパティ | メソッド | イベント | 詳細トップ | ページトップ |
|---|
|
新しいJSDOC.SymbolSetオブジェクトを作成する。
|
| void |
addSymbol(symbol)
シンボルを追加します。追加しようとしているシンボルと同じエイリアスを持つシンボルが既に登録されている場合、
エイリアスと関連付けられたオブジェクト内の参照は新たに追加されたシンボルに移ります。
|
| JSDOC.Symbol |
deleteSymbol(alias)
シンボルのエイリアスを引数として受け取り、対応するシンボルオブジェクトの登録を削除します。
|
| JSDOC.Symbol |
getSymbol(alias)
シンボルのエイリアスを引数として受け取り、対応するシンボルオブジェクトを返します。
|
| JSDOC.Symbol |
getSymbolByName(name)
（エイリアスではなく）名前でシンボルを検索し、最初に見つかったものを返します。
|
| String |
hasSymbol(alias)
シンボルのエイリアスを引数として受け取り、対応するシンボルが存在すればtrueを、しなければfalseを返します。
|
| String |
keys()
オブジェクトに登録されている全てのシンボルのエイリアスの配列を返します。
|
| String |
renameSymbol(oldName , newName)
oldNameで登録されたシンボルのエイリアスをnewNameに置換し、新しいエイリアスを返します。
|
| JSDOC.Symbol[] |
toArray()
このオブジェクトに保持されている全てのシンボルオブジェクトの配列を返します。
|
詳細 | コンストラクタ | 定数 | プロパティ | メソッド | イベント | 概要トップ | ページトップ |
|---|
新しいJSDOC.SymbolSetオブジェクトを作成する。
メソッド
↑
シンボルを追加します。追加しようとしているシンボルと同じエイリアスを持つシンボルが既に登録されている場合、
エイリアスと関連付けられたオブジェクト内の参照は新たに追加されたシンボルに移ります。
| 引数 |
|
シンボルのエイリアスを引数として受け取り、対応するシンボルオブジェクトの登録を削除します。
| 引数 |
| |||
| 戻り値 |
|
シンボルのエイリアスを引数として受け取り、対応するシンボルオブジェクトを返します。
| 引数 |
| |||
| 戻り値 |
|
（エイリアスではなく）名前でシンボルを検索し、最初に見つかったものを返します。
| 引数 |
| |||
| 戻り値 |
|
シンボルのエイリアスを引数として受け取り、対応するシンボルが存在すればtrueを、しなければfalseを返します。
| 引数 |
| |||
| 戻り値 |
|
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)