mxsdoc

依存

• docGeneratorDefinitionPool
• MarkdownStruct
• ParserCombinatorStruct
• std

struct DocGeneratorStruct

スクリプトファイル内のドキュメントコメントを基にHTMLファイルを生成する。

public Options

プロパティ

<Struct:DocOptionsStruct>

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

private docDependentParser

プロパティ

<Struct:DocDependentStruct>

private docDependentTable

プロパティ

<Struct:DocDependentTableStruct>

private docParser

プロパティ

<Struct:DocStruct>

private docRender

プロパティ

<Struct:DocRenderStruct>

private pathMaker

プロパティ

<Struct:DocPathMakerStruct>

private pathUtility

プロパティ

<Struct:PathUtilityStruct>

public fn FromDirectory

ディレクトリ内のスクリプトファイルを変換する。

パラメータ

dir

<String>

ディレクトリの絶対パス。

パラメータ

recursive:

<BooleanClass>

全てのサブディレクトリから検索する場合はtrue、現在のディレクトリからのみ検索する場合はfalse。既定値はfalse。

パラメータ

ignore:

<String|Array[<String>]>

結果から除外するパスのパターン。既定値はunsupplied。
リテラル文字とワイルドカード文字の組み合わせ。大文字と小文字を区別しない。

パラメータ

exception:

<String|Array[<String>]>

ignoreに一致しても除外しない例外パターン。既定値はunsupplied。

戻り値

<OkClass>

public fn FromFile

スクリプトファイルを変換する。

パラメータ

file

<String>

ファイルの絶対パス。

戻り値

<OkClass>

補足

依存情報の解析は指定したファイルのみで行われるため正しく抽出できない。

public fn IndexFromDirectory

ディレクトリ内のスクリプトファイルからインデックスページを生成する。

パラメータ

dir

<String>

ディレクトリの絶対パス。

パラメータ

recursive:

<BooleanClass>

全てのサブディレクトリから検索する場合はtrue、現在のディレクトリからのみ検索する場合はfalse。既定値はfalse。

パラメータ

ignore:

<String|Array[<String>]>

結果から除外するパスのパターン。既定値はunsupplied。
リテラル文字とワイルドカード文字の組み合わせ。大文字と小文字を区別しない。

パラメータ

exception:

<String|Array[<String>]>

ignoreに一致しても除外しない例外パターン。既定値はunsupplied。

戻り値

<OkClass>

補足

HTMLファイルの書き込みは常にUTF-8Nで行う。

private fn convertFile

パラメータ

path

<DataPair Source:<String> Destination:<String>>

戻り値

<OkClass>

補足

HTMLファイルの書き込みは常にUTF-8Nで行う。

private fn compareFileName

ディレクトリが前、ファイルが後になるように並べ替える。

パラメータ

a

<Any>

パラメータ

b

<Any>

戻り値

<Integer>

private fn dumpPathTree

パスの階層構造をリスナーに出力する。デバッグ用。

パラメータ

pathTree

<Array[<DataPair Name:<String> Value:<Array[<Any>]|DataPair Source:<String> Destination:<String>>>]>

パラメータ

indent

<String>

戻り値

<OkClass>

private fn extractDependent

依存情報を抽出する。

パラメータ

path

<DataPair Source:<String> Destination:<String>>

戻り値

<OkClass>

private fn isDocOptions

パラメータ

obj

<Any>

戻り値

<BooleanClass>

private fn makePathTree

パスの配列からディレクトリやファイルの階層構造を構築する。

パラメータ

parentPath

<String>

親ディレクトリのパス。

パラメータ

paths

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

戻り値

<Array[<DataPair Name:<String> Value:<Array[<Any>]|DataPair Source:<String> Destination:<String>>>]>

補足

終端（ファイル）のValueには子階層の配列ではなくファイルのパス情報が格納される。

private fn pathTreeToHtml

パスの階層構造からリスト要素のHTMLコードを生成する。

パラメータ

pathTree

<Array[<DataPair Name:<String> Value:<Array[<Any>]|DataPair Source:<String> Destination:<String>>>]>

戻り値

<String>

private version

プロパティ

<Array[<Integer>]>

バージョン番号。メジャー、マイナー、パッチの順。

public fn StructName

戻り値

<Name>

public fn Dump

パラメータ

indent:

<String>

パラメータ

out:

<FileStream|StringStream|WindowStream>

出力先。既定値はlistener。

戻り値

<OkClass>

public fn Equals

パラメータ

obj

<Any>

戻り値

<BooleanClass>

補足

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

public fn GetVersion

戻り値

<Array[<Integer>]>