DocTagオブジェクトはドックコメント内のタグをパースした結果をプロパティに保持しています。
(ただしタグの種類により、全てのプロパティに実際に値が設定されているわけではありません。)
このクラスのインスタンスはJSDOC.DocComment#getTagメソッドまたはJSDOC.DocComment#tagsプロパティから取得できます。
このクラスのインスタンスはJSDOC.DocComment#getTagメソッドまたはJSDOC.DocComment#tagsプロパティから取得できます。
名前空間 | JSDOC |
---|---|
継承関係 | JSDOC.DocTag |
定義 | DocTag.js |
他のクラスから継承したメンバを折りたたむ
プライベートメンバを隠す
プライベートメンバを隠す
概要 | コンストラクタ | 定数 | プロパティ | メソッド | イベント | 詳細トップ | ページトップ |
---|
JSDOC.DocTag(src)
新しいJSDOC.DocTagオブジェクトを作成する。
|
String |
デフォルト値。@defaultタグの値や@paramタグでのパラメータのデフォルト値が設定されます。
|
String |
タグの説明文
|
String |
@paramタグにおいて、パラメータが省略可能ならtrueが設定されます。
|
String |
データの名前。@paramタグなどデータ名定義が記述されているタグで値が設定されます。
|
String |
タグタイトル(タグ名から"@"を除いたもの)
|
String |
データ型。@propertyタグなどデータ型定義が記述されているタグで値が設定されます。
|
String |
toString()
オブジェクトの文字列表現として、タグの説明文を返します。
|
詳細 | コンストラクタ | 定数 | プロパティ | メソッド | イベント | 概要トップ | ページトップ |
---|
新しいJSDOC.DocTagオブジェクトを作成する。
引数 |
|
プロパティ
↑
メソッド
↑
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)