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

String desc
タグの説明文

String isOptional
@paramタグにおいて、パラメータが省略可能ならtrueが設定されます。

String name
データの名前。@paramタグなどデータ名定義が記述されているタグで値が設定されます。

String title
タグタイトル(タグ名から"@"を除いたもの)

String type
データ型。@propertyタグなどデータ型定義が記述されているタグで値が設定されます。
メソッド
String toString()
オブジェクトの文字列表現として、タグの説明文を返します。

Automatically called when this is stringified.

戻り値
String タグの説明文
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)