mxsdoc

依存

• docGeneratorDefinitionPool
• MarkdownStruct
• std

struct DocRenderStruct

ドキュメントの構文木をHTMLコードに変換する。

補足

テンプレートHTML内で使用可能な変数は以下の通り。

変数	説明
site.title	全体のタイトル。
site.url	インデックスページのURL。
doc.title	ドキュメントのタイトル。
doc.toc	目次。
doc.update	ドキュメントの更新日時。書式はOptions.DateFormatプロパティで指定する。
doc.content	ドキュメント本文。

変数は{{{変数}}}のように波括弧で括って使用する。

public Options

プロパティ

<Struct:DocOptionsStruct>

既定値はundefined。未指定の場合は既定値で作成される。

private template

プロパティ

<String>

テンプレートHTMLコード。

private toc

プロパティ

<StringStream>

TOC生成用の一時変数。

private defaultTemplate

プロパティ

<String>

テンプレートHTMLが使用できない場合に使用する既定のテンプレートHTMLコード。

private markdown

プロパティ

<Struct:MarkdownStruct>

private pathUtility

プロパティ

<Struct:PathUtilityStruct>

private spaceRegex

プロパティ

<DotNetObject:System.Text.RegularExpressions.Regex>

(?<=\n) +に一致する正規表現オブジェクト。

private uriClass

プロパティ

<DotNetClass:System.Uri>

public fn Render

構文木からHTMLコードを生成する。

パラメータ

astNode

<Struct:AstNodeStruct>

パース結果の構文木。

パラメータ

docTitle:

<String>

ドキュメントのタイトル。既定値は"Untitled"。

パラメータ

dependent:

<DataPair VarName:<Array[<String>]> Path:<Array[<Array[<DataPair Source:<String> Destination:<String>>]>]>>

DocDependentTableStructから取得した依存情報。既定値はunsupplied。

戻り値

<String>

HTMLコード。

補足

依存情報を含める場合はdependentを指定する。

public fn RenderIndex

インデックスページ用のHTMLコードを生成する。

パラメータ

docContent

<String>

各ドキュメントへのアンカーで更生されたHTMLコード。

戻り値

<String>

HTMLコード。

private fn adjustIndent

テキストのインデントを指定したインデントに置き換える。

パラメータ

input

<String>

パラメータ

indent:

<String>

最終的なインデント。既定値は" "。

戻り値

<String>

private fn dependentToHtml

パラメータ

dependent

<DataPair VarName:<Array[<String>]> Path:<Array[<Array[<DataPair Source:<String> Destination:<String>>]>]>|UnsuppliedClass>

戻り値

<String>

private fn docCommentToHtml

パラメータ

n

<Struct:AstNodeStruct>

パラメータ

dependent

<DataPair VarName:<Array[<String>]> Path:<Array[<Array[<DataPair Source:<String> Destination:<String>>]>]>>

DocDependentTableStructから取得した依存情報。

戻り値

<String>

private fn docToHtml

パラメータ

n

<Struct:AstNodeStruct>

パラメータ

h

<Integer>

現在のヘッダレベル。

パラメータ

dependent

<DataPair VarName:<Array[<String>]> Path:<Array[<Array[<DataPair Source:<String> Destination:<String>>]>]>>

DocDependentTableStructから取得した依存情報。

戻り値

<String>

private fn generateNowDate

現在の日付を取得する。

戻り値

<String>

private fn isAstNode

パラメータ

obj

<Any>

戻り値

<BooleanClass>

private fn isDocOptions

パラメータ

obj

<Any>

戻り値

<BooleanClass>

private fn isValidDependent

パラメータ

obj

<Any>

戻り値

<BooleanClass>

private fn isValidMarkdown

パラメータ

obj

<Any>

戻り値

<BooleanClass>

private fn readTemplate

テンプレートHTMLファイルの内容を読み込んでtemplateに割り当てる。

戻り値

<String>

補足

ファイルが読み込めなかった場合や内容が空の場合はdefaultTemplateの内容を返す。

private fn sanitize

&、"、<、>、 を文字実体参照に置換する。

パラメータ

input

<String>

戻り値

<String>

private fn writeTocBorderTag

パラメータ

n

<Struct:AstNodeStruct>

パラメータ

i

<Integer>

戻り値

<OkClass>

private fn writeTocEndTag

パラメータ

n

<Struct:AstNodeStruct>

パラメータ

i

<Integer>

戻り値

<OkClass>

public fn StructName

戻り値

<Name>

public fn Dump

パラメータ

indent:

<String>

パラメータ

out:

<FileStream|StringStream|WindowStream>

出力先。既定値はlistener。

戻り値

<OkClass>

public fn Equals

パラメータ

obj

<Any>

戻り値

<BooleanClass>

補足

大文字と小文字を区別する。