mxsdoc

依存

• std

struct DocOptionsStruct

ドキュメントのHTMLファイル化に必要なプロパティを格納する構造体。

public BasePath

プロパティ

<String>

検索の基点になるディレクトリの絶対パスまたは相対パス。既定値は@"..\"。

public DateFormat

プロパティ

<String>

更新日に使用する日時書式指定文字列。既定値は"yyyy-MM-dd"。

public DotNetApiBaseUrl

プロパティ

<String>

自動リンクに使用する.NET APIブラウザのベースURL。既定値は"https://docs.microsoft.com/ja-jp/dotnet/api/"。

public DotNetApiVersion

プロパティ

<String>

自動リンクに使用する.NET APIブラウザのバージョン。既定値は"netframework-4.8"。

public EncodingBom

プロパティ

<BooleanClass>

UTF-8エンコーディングのBOMの有無。既定値はfalse。

public EncodingName

プロパティ

<String>

スクリプトファイルのエンコーディングの名前。既定値は"utf-8"

public FileNameSeparator

プロパティ

<String>

HTMLファイル名のセパレータ。既定値は"-"。

public SaveDirectoryName

プロパティ

<String>

HTMLファイルの保存先ディレクトリ名。既定値は"Document"。

public ShowError

プロパティ

<BooleanClass>

public SiteTitle

プロパティ

<String>

全体のタイトル。既定値は"mxsdoc"。

public SiteUrl

プロパティ

<String>

インデックスページのURL。既定値は"index.html"。

public TemplatePath

プロパティ

<String>

テンプレートHTMLファイルの絶対パスまたは相対パス。既定値は@"DocGenerator.Template\default-template.html"。

public fn StructName

戻り値

<Name>

public fn Dump

パラメータ

indent:

<String>

パラメータ

out:

<FileStream|StringStream|WindowStream>

出力先。既定値はlistener。

戻り値

<OkClass>

public fn Equals

パラメータ

obj

<Any>

戻り値

<BooleanClass>

補足

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