Table of Contents
Constants
-
ASSET_TEMPLATES
= 'farah://slothsoft@unity/docfx-templates'
-
DEFAULT_FILTER
= <<<EOT
apiRules:
- exclude:
uidRegex: ^System\\.Object
type: Type
- exclude:
uidRegex: ^UnityEngine\\.Object
type: Type
EOT
-
DEFAULT_INDEX
= <<<EOT
# Documentation
Add a README.md to your repository to change this page.
EOT
-
DIR_API
= 'api'
-
DIR_DOCS
= 'docs'
-
DIR_TEMPLATE
= 'templates' . DIRECTORY_SEPARATOR . 'unity'
-
FILE_CHANGELOG
= 'CHANGELOG.md'
-
FILE_DOCFX
= 'docfx.json'
-
FILE_FILTER
= 'filterConfig.yml'
-
FILE_INDEX
= 'index.md'
-
FILE_LICENSE
= 'LICENSE.md'
-
FILE_README
= 'README.md'
-
FILE_TOC
= 'toc.yml'
Methods
-
__construct()
: mixed
-
__toString()
: string
-
export()
: string
-
setTemplate()
: void
ASSET_TEMPLATES
public
mixed
ASSET_TEMPLATES
= 'farah://slothsoft@unity/docfx-templates'
DEFAULT_FILTER
public
mixed
DEFAULT_FILTER
= <<<EOT
apiRules:
- exclude:
uidRegex: ^System\\.Object
type: Type
- exclude:
uidRegex: ^UnityEngine\\.Object
type: Type
EOT
DEFAULT_INDEX
public
mixed
DEFAULT_INDEX
= <<<EOT
# Documentation
Add a README.md to your repository to change this page.
EOT
DIR_API
public
mixed
DIR_API
= 'api'
DIR_DOCS
public
mixed
DIR_DOCS
= 'docs'
DIR_TEMPLATE
public
mixed
DIR_TEMPLATE
= 'templates' . DIRECTORY_SEPARATOR . 'unity'
FILE_CHANGELOG
public
mixed
FILE_CHANGELOG
= 'CHANGELOG.md'
FILE_DOCFX
public
mixed
FILE_DOCFX
= 'docfx.json'
FILE_FILTER
public
mixed
FILE_FILTER
= 'filterConfig.yml'
FILE_INDEX
public
mixed
FILE_INDEX
= 'index.md'
FILE_LICENSE
public
mixed
FILE_LICENSE
= 'LICENSE.md'
FILE_README
public
mixed
FILE_README
= 'README.md'
FILE_TOC
public
mixed
FILE_TOC
= 'toc.yml'
__construct()
public
__construct(string $path) : mixed
Parameters
-
$path
: string
-
__toString()
public
__toString() : string
export()
public
export([string $target = null ]) : string
Parameters
-
$target
: string
= null
-
setTemplate()
public
setTemplate(string $template) : void
Parameters
-
$template
: string
-