Documentation

Settings
in package

FinalYes

Creates DocFX configuration, templates, and table-of-contents files for Unity projects.

Tags
author

Daniel Schulz

since
2023-03-07

Table of Contents

Constants

ASSET_TEMPLATES  : mixed = 'farah://slothsoft@unity/docfx-templates'
DEFAULT_FILTER  : mixed = <<<EOT apiRules: - exclude: uidRegex: ^System\\...
DEFAULT_INDEX  : mixed = <<<EOT # Documentation Add a README.md to your...
DIR_API  : mixed = 'api'
DIR_DOCS  : mixed = 'docs'
DIR_TEMPLATE  : mixed = 'templates' . DIRECTORY_SEPARATOR . 'unity'
FILE_CHANGELOG  : mixed = 'CHANGELOG.md'
FILE_DOCFX  : mixed = 'docfx.json'
FILE_FILTER  : mixed = 'filterConfig.yml'
FILE_INDEX  : mixed = 'index.md'
FILE_LICENSE  : mixed = 'LICENSE.md'
FILE_README  : mixed = 'README.md'
FILE_TOC  : mixed = 'toc.yml'

Methods

__construct()  : mixed
__toString()  : string
export()  : string
setTemplate()  : void

Constants

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_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'

Methods

__construct()

public __construct(string $path) : mixed
Parameters
$path : string

__toString()

public __toString() : string
Return values
string

export()

public export([string|null $target = null ]) : string
Parameters
$target : string|null = null
Return values
string

setTemplate()

public setTemplate(string $template) : void
Parameters
$template : string
On this page

Search results