JsDoc Toolkit テンプレート開発者向けAPIリファレンス

CONSTRUCTOR	クラス（コンストラクタ）、名前空間
FILE	ファイル
FUNCTION	関数、メソッド、イベント
OBJECT	上記以外のオブジェクト（変数、プロパティなど）

Boolean

isConstant

このシンボルが定数ならtrue

Boolean

isEvent

このシンボルがイベントならtrue

Boolean

isInner

このシンボルが内部関数ならtrue

Boolean

isNamespace

このシンボルが名前空間ならtrue

Boolean

isPrivate

このシンボルのスコープがprivateならtrue

Boolean

isStatic

このシンボルが静的メンバならtrue

String

memberOf

このシンボルがメンバとして定義されているシンボルのエイリアス

JSDOC.Symbol[]

methods

このシンボルがメンバとしているメソッドシンボルの配列。他のクラスから継承しているものも含みます。

String

name

このシンボルの名前。

JSDOC.DocTag[]

params

シンボルのパラメータを表すタグオブジェクトの配列

JSDOC.Symbol[]

properties

このシンボルがメンバとしているプロパティシンボルの配列。他のクラスから継承しているものも含みます。

String[]

requires

このシンボルが依存するシンボルのエイリアスの配列

JSDOC.DocTag[]

returns

メソッドの戻り値。@returnsタグをパースしたタグオブジェクトの配列です。

String[]

see

関連項目へのリンクを含むHTMLテキストまたはシンボルエイリアスの配列

String

since

このシンボルが使用可能になったバージョンに関する情報。@sinceタグから作成されます。

String

srcFile

このシンボルが定義されているソースファイルのパス

String

type

データ型（クラスの場合はエイリアス）

String

version

バージョン。@versionタグから作成されます。

メソッド ↑
void	addMember(symbol) このシンボルにメンバを追加します。
void	addMethod(symbol) このシンボルにメソッドを追加します。
void	addProperty(symbol) このシンボルにプロパティを追加します。
JSDOC.Symbol	clone() このシンボルの複製を返します。
JSDOC.Symbol[]	getEvents() このシンボルに含まれる全てのイベントシンボルの配列を返します。
JSDOC.Symbol[]	getMethods() このシンボルに含まれる全てのメソッドシンボルの配列を返します。
Boolean	hasMember(name) 引数で指定された名前かエイリアスのシンボルをメンバに持っていればtrueを返します。
Boolean	hasMethod(name) 引数で指定された名前かエイリアスのメソッドを持っていればtrueを返します。
Boolean	hasProperty(name) 引数で指定された名前かエイリアスのプロパティを持っていればtrueを返します。
Boolean	is(what) 引数で指定したシンボル種別文字列がisaプロパティの値と一致していればtrueを返します。
Boolean	isBuiltin() このシンボルがJavaScriptの組み込み関数やオブジェクトを表していればtrueを返します。

詳細	コンストラクタ \| 定数 \| プロパティ \| メソッド \| イベント \| 概要トップ \| ページトップ

コンストラクタ ↑

JSDOC.Symbol()

↑

Create a new Symbol.

プロパティ ↑

String alias

↑

シンボルの完全なネームパスで表される一意な名称

JSDOC.DocTag[] augments

↑

このシンボルの継承元クラス情報を保持する、@augmentsタグから作成されたタグオブジェクトの配列

String author

↑

作者情報。@authorタグが複数記述されていた場合、カンマ区切りの文字列に結合されています。

String classDesc

↑

クラスの説明文。@classタグまたは@namespaceタグの説明文が設定されています。

JSDOC.DocComment comment

↑

このシンボルのドックコメントをパースしたドックコメントオブジェクト

String defaultValue

↑

デフォルト値。@defaultタグの内容が設定されています。

String deprecated

↑

非推奨情報。@deprecatedタグが複数記述されていた場合、改行文字区切りの文字列に結合されています。

String desc

↑

シンボルの説明文。ドックコメントの先頭に書かれたタグなしの説明文や、@descriptionタグの説明文が設定されています。またシンボル種別が FILE の場合、@fileOverviewタグの説明文が設定されています。
これらが複数記述されていた場合、改行文字区切りの文字列に結合されています。

JSDOC.DocTag[] example

↑

サンプルコード。@exampleタグをパースしたタグオブジェクトの配列です。

JSDOC.DocTag[] exceptions

↑

例外。@throwsタグをパースしたDocTagオブジェクトの配列です。

Number id

↑

システムによって全シンボルに付与された一意の番号

Object[] inherits

↑

メンバの借用関係を示す無名オブジェクトの配列。@borrowsタグから作成されます。
無名オブジェクトは以下のプロパティを持ちます。

プロパティ

String	alias	借用元メンバのエイリアス
String	as	借用先メンバのエイリアス

JSDOC.Symbol[] inheritsFrom

↑

このシンボルの継承元クラスを表すシンボルオブジェクトの配列。@augmentsタグから作成されます。

String isa

↑

シンボルの種別を表す文字列

CONSTRUCTOR	クラス（コンストラクタ）、名前空間
FILE	ファイル
FUNCTION	関数、メソッド、イベント
OBJECT	上記以外のオブジェクト（変数、プロパティなど）

Boolean isConstant

↑

このシンボルが定数ならtrue

Boolean isEvent

↑

このシンボルがイベントならtrue

Boolean isInner

↑

このシンボルが内部関数ならtrue

Boolean isNamespace

↑

このシンボルが名前空間ならtrue

Boolean isPrivate

↑

このシンボルのスコープがprivateならtrue

Boolean isStatic

↑

このシンボルが静的メンバならtrue

String memberOf

↑

このシンボルがメンバとして定義されているシンボルのエイリアス

JSDOC.Symbol[] methods

↑

このシンボルがメンバとしているメソッドシンボルの配列。他のクラスから継承しているものも含みます。

String name

↑

このシンボルの名前。 aliasプロパティがネームパスによるシンボルの一意な識別子であるのに対し、 nameプロパティにはメソッド名のような単純な名称が設定されます。

JSDOC.DocTag[] params

↑

シンボルのパラメータを表すタグオブジェクトの配列

JSDOC.Symbol[] properties

↑

このシンボルがメンバとしているプロパティシンボルの配列。他のクラスから継承しているものも含みます。

String[] requires

↑

このシンボルが依存するシンボルのエイリアスの配列

JSDOC.DocTag[] returns

↑

メソッドの戻り値。@returnsタグをパースしたタグオブジェクトの配列です。

String[] see

↑

関連項目へのリンクを含むHTMLテキストまたはシンボルエイリアスの配列

String since

↑

このシンボルが使用可能になったバージョンに関する情報。@sinceタグから作成されます。
タグが複数記述されていた場合、カンマ区切りの文字列に結合されています。

String srcFile

↑

このシンボルが定義されているソースファイルのパス

String type

↑

データ型（クラスの場合はエイリアス）

String version

↑

バージョン。@versionタグから作成されます。
タグが複数記述されていた場合、カンマ区切りの文字列に結合されています。

メソッド ↑

void addMember(symbol)

↑

このシンボルにメンバを追加します。追加しようとするシンボルの種別によって、メソッドかプロパティかが自動的に判定されます。

引数

JSDOC.Symbol symbol メンバとして追加するシンボル

void addMethod(symbol)

↑

このシンボルにメソッドを追加します。同名のメソッドが既に存在する場合、新しいシンボルで上書きされます。

引数

JSDOC.Symbol symbol メソッドとして追加するシンボル

void addProperty(symbol)

↑

このシンボルにプロパティを追加します。同名のプロパティが既に存在する場合、新しいシンボルで上書きされます。

引数

JSDOC.Symbol symbol プロパティとして追加するシンボル

JSDOC.Symbol clone()

↑

このシンボルの複製を返します。

戻り値

JSDOC.Symbol

シンボルの複製

JSDOC.Symbol[] getEvents()

↑

このシンボルに含まれる全てのイベントシンボルの配列を返します。

戻り値

JSDOC.Symbol[]

イベントシンボルの配列

JSDOC.Symbol[] getMethods()

↑

このシンボルに含まれる全てのメソッドシンボルの配列を返します。

戻り値

JSDOC.Symbol[]

メソッドシンボルの配列

Boolean hasMember(name)

↑

引数で指定された名前かエイリアスのシンボルをメンバに持っていればtrueを返します。

引数

String name シンボルの名前またはエイリアス

戻り値

Boolean

シンボルをメンバに持っていればtrue、そうでなければfalse

Boolean hasMethod(name)

↑

引数で指定された名前かエイリアスのメソッドを持っていればtrueを返します。

引数

String name シンボルの名前またはエイリアス

戻り値

Boolean

シンボルをメソッドに持っていればtrue、そうでなければfalse

Boolean hasProperty(name)

↑

引数で指定された名前かエイリアスのプロパティを持っていればtrueを返します。

引数

String name シンボルの名前またはエイリアス

戻り値

Boolean

シンボルをプロパティに持っていればtrue、そうでなければfalse

Boolean is(what)

↑

引数で指定したシンボル種別文字列がisaプロパティの値と一致していればtrueを返します。

引数

String what シンボル種別

戻り値

Boolean

引数とシンボル種別が一致していればtrue、そうでなければfalse