mxsdoc

依存

• docGeneratorDefinitionPool
• std

struct DocPathMakerStruct

ドキュメントのパスを生成する。

補足

ベースパスから見た相対パスが生成されるパスのファイル名になる。

ベースパス	変換対象	生成されるパス
C:\Foo\Bar	C:\Foo\Bar\Hoge\Piyo\script.ms	C:\Foo\Bar\Document\hoge-piyo-script.ms
C:\Foo	C:\Foo\Bar\Hoge\Piyo\script.ms	C:\Foo\Document\bar-hoge-piyo-script.ms

public Options

プロパティ

<Struct:DocOptionsStruct>

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

private pathUtility

プロパティ

<Struct:PathUtilityStruct>

private uriClass

プロパティ

<DotNetClass:System.Uri>

public fn FromDirectory

ディレクトリ内のスクリプトファイルのパスから変換後のHTMLファイルのパスを作成する。

パラメータ

dir

<String>

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

パラメータ

recursive:

<BooleanClass>

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

パラメータ

ignore:

<String|Array[<String>]>

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

パラメータ

exception:

<String|Array[<String>]>

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

戻り値

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

public fn FromFile

スクリプトファイルのパスから変換後のHTMLファイルのパスを作成する。

パラメータ

file

<String>

ファイルの絶対パス。

戻り値

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

public fn GetAbsoluteBasePath

Options.BasePathを絶対パスで取得する。

戻り値

<String>

public fn GetAbsoluteIndexPath

Options.SiteUrlを絶対パスで取得する。

戻り値

<String>

public fn GetAbsoluteTemplatePath

Options.TemplatePathを絶対パスで取得する。

戻り値

<String>

private fn isDocOptions

パラメータ

obj

<Any>

戻り値

<BooleanClass>

private fn matchPatterns

パラメータ

input

<String>

パラメータ

patterns

<Array[<String>]>

戻り値

<BooleanClass>

private fn trimEndBackslash

末尾のバックスラッシュを除去する。

パラメータ

input

<String>

戻り値

<String>

public fn StructName

戻り値

<Name>

public fn Dump

パラメータ

indent:

<String>

パラメータ

out:

<FileStream|StringStream|WindowStream>

出力先。既定値はlistener。

戻り値

<OkClass>

public fn Equals

パラメータ

obj

<Any>

戻り値

<BooleanClass>

補足

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