Class DocFXConfig
Data structure that contains the DocFX config file in a format that can be easily serialized to json.
Inherited Members
Namespace: UnityEditor.PackageManager.DocumentationTools.UI
Assembly: Unity.PackageManagerDocTools.Editor.dll
Syntax
public class DocFXConfigConstructors
| Name | Description |
|---|---|
| DocFXConfig() | |
| DocFXConfig(string) | Would create a new config object by reading the file, if only it were implemented. |
| DocFXConfig(PackageInfo) | Makes a config with default settings based on the package info. |
Methods
| Name | Description |
|---|---|
| AddCSProjectProperties(string, string) | |
| AddContentToSection(string, string, string[]) | |
| AddContentToSection(string, string, string[], string[]) | |
| AddDllReferences(string, string) | |
| AddDocFXTemplate(string) | |
| AddImageFolder(string, string, string[]) | |
| AddToProjSrcFiles(string, string) | Add a file to the sources for the metadata in the config maps to "metadata.src.files"[] in docfx.json |
| AddXrefmapURL(string) | |
| GetGlobalMetadata() | |
| MakeDefaultConfig(PackageInfo) | Factory method to create a config object from a package info. |
| SetAllowCompilationErrors(bool) | |
| SetForceRebuildOption(bool) | |
| SetGlobalMetadata(string, object) | |
| SetGlobalNamespace(string) | |
| SetMemberLayout(string) | |
| SetNoLangKeywordOption(bool) | |
| SetTOCEnabled(bool) | |
| WriteConfig(string) |