LinkクラスはシンボルやファイルへのHTMLリンク（<a>タグ）を作成する機能を提供します。
Linkオブジェクトのメソッドのほとんどは自分自身への参照を返すため、以下のようにリンクの設定処理をチェーンした後、 最終的にtoStringメソッドでタグ文字列を出力するのが標準的な使用方法です。
new Link().toSymbol("MySymbol").withText("マイシンボル").target("_blank").toString();
上の処理は次のようなHTMLテキストを出力します。（シンボルの出力先設定は標準テンプレートと同一と仮定） 
<a href="./symbols/MySymbol.html" target="_blank" >マイシンボル</a>
注意: Linkオブジェクトを正常に動作させるには、テンプレートのpublish関数にconfプロパティが存在していなくてはなりません。

Handle the creation of HTML links to documented symbols.

継承関係 Link
定義Link.js
他のクラスから継承したメンバを折りたたむ
プライベートメンバを隠す
概要
 コンストラクタ | 定数 | プロパティ | メソッド | イベント | 詳細トップ | ページトップ
コンストラクタ ↑
 
Link()
新しいLinkオブジェクトを作成する。
プロパティ ↑
<static>
String
Link.base
作成されるリンクの、ドキュメント出力ディレクトリとの相対位置を示すパス文字列（"../"など）

Appended to the front of relative link paths.
<static>
String
Link.hashPrefix
Link.symbolNameToLinkNameメソッドでシンボル名からページ内リンクのアンカー名を作成する際、 アンカー名の先頭に付加されるプリフィックス

prefixed for hashes
<static>
JSDOC.SymbolSet
Link.symbolSet
シンボルセット。ネームパスからシンボルを取得するために使用します。
メソッド ↑
<private>
void
_makeFileLink(filePath)
Create a link to a source file.
<private>
void
_makeSrcLink(srcFilePath)
Create a link to a source file.
<private>
void
_makeSymbolLink(alias)
Create a link to another symbol.
Link
inner(inner)
ページ内リンクのアンカー名を設定します。
<static>
String
Link.symbolNameToLinkName(symbol)
クラスシンボルから、そのシンボルを表すリンクアンカー名を作成します。
Link
target(targetName)
<a>タグのtarget属性の値を設定します。
Link
toClass(alias)
リンク先としてクラスシンボルのエイリアスを設定します。
※現行バージョンではこのメソッドとtoSymbolメソッドの動作に違いはありません。
Link
toFile(file)
リンク先としてファイルパスを設定します。
Link
toSrc(filename)
リンク先としてソースファイル名を設定します。これはハイライトされたソースコードファイルへのリンクとなります。
String
toString()
オブジェクトの文字列表現として、現在の設定に基づいて作成された<a>タグのHTMLテキストを返します。
Link
toSymbol(alias)
リンク先としてシンボルのエイリアスを設定します。
Link
withText(text)
リンクテキストを設定します。
詳細
 コンストラクタ | 定数 | プロパティ | メソッド | イベント | 概要トップ | ページトップ
コンストラクタ ↑
Link()
↑
新しいLinkオブジェクトを作成する。
プロパティ ↑
<static> String Link.base
↑
作成されるリンクの、ドキュメント出力ディレクトリとの相対位置を示すパス文字列（"../"など）

Appended to the front of relative link paths.

<static> String Link.hashPrefix
↑
Link.symbolNameToLinkNameメソッドでシンボル名からページ内リンクのアンカー名を作成する際、 アンカー名の先頭に付加されるプリフィックス

prefixed for hashes

<static> JSDOC.SymbolSet Link.symbolSet
↑
シンボルセット。ネームパスからシンボルを取得するために使用します。 Linkクラスをテンプレートから使用する場合、publish()関数が受け取ったJSDOC.SymbolSetオブジェクトを 事前にこのプロパティに設定しておく必要があります。
メソッド ↑
<private> void _makeFileLink(filePath)
↑
Create a link to a source file.
引数
unknown filePath
<private> void _makeSrcLink(srcFilePath)
↑
Create a link to a source file.
引数
unknown srcFilePath
<private> void _makeSymbolLink(alias)
↑
Create a link to another symbol.
引数
unknown alias
Link inner(inner)
↑
ページ内リンクのアンカー名を設定します。
引数
String inner アンカー名
戻り値
Link このオブジェクトへの参照
<static> String Link.symbolNameToLinkName(symbol)
↑
クラスシンボルから、そのシンボルを表すリンクアンカー名を作成します。
引数
JSDOC.Symbol symbol クラスシンボル
戻り値
String リンクアンカー名
Link target(targetName)
↑
<a>タグのtarget属性の値を設定します。
引数
String targetName target属性値
戻り値
Link このオブジェクトへの参照
Link toClass(alias)
↑
リンク先としてクラスシンボルのエイリアスを設定します。
※現行バージョンではこのメソッドとtoSymbolメソッドの動作に違いはありません。
引数
String alias クラスシンボルのエイリアス
戻り値
Link このオブジェクトへの参照
Link toFile(file)
↑
リンク先としてファイルパスを設定します。
引数
String file Link.baseプロパティの位置を基準としたファイルの相対パス
戻り値
Link このオブジェクトへの参照
Link toSrc(filename)
↑
リンク先としてソースファイル名を設定します。これはハイライトされたソースコードファイルへのリンクとなります。
引数
String filename ソースファイル名
戻り値
Link このオブジェクトへの参照
String toString()
↑
オブジェクトの文字列表現として、現在の設定に基づいて作成された<a>タグのHTMLテキストを返します。
戻り値
String <a>タグのHTMLテキスト
Link toSymbol(alias)
↑
リンク先としてシンボルのエイリアスを設定します。
引数
String alias シンボルのエイリアス
戻り値
Link このオブジェクトへの参照
Link withText(text)
↑
リンクテキストを設定します。 この指定を行わなかった場合、状況に応じてシンボルエイリアスやファイルパスが出力されます。
引数
String text リンクテキスト
戻り値
Link このオブジェクトへの参照
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)