Class YamlWriter
Object to save SourceInfo into YML-file
Inheritance
object
YamlWriter
Namespace: BuildSystem.GenDoc.DocFX
Assembly: BuildSystem.GenDoc.DocFX.dll
Syntax
public class YamlWriter : ObjectConstructors
YamlWriter(List<SourceInfo>)
Object to save SourceInfo into YML-file
Declaration
public YamlWriter(List<SourceInfo> sourceInfos)Parameters
| Type | Name | Description |
|---|---|---|
| System.Collections.Generic.List<><SourceInfo> | sourceInfos |
Methods
CreateToc(string, bool)
Adds links from BuildSystem.GenDoc.DocFX.YamlWriter._sourceInfos to toc.yml file. Creates if not exists.
Declaration
public void CreateToc(string folderPath, bool append = false)Parameters
| Type | Name | Description |
|---|---|---|
| string | folderPath | Target folder of YML-files |
| bool | append | Clean yml before adding |
MergeYmlFolders(string, string)
Copies all YML files into target folder. Merges toc.yml
Declaration
public static void MergeYmlFolders(string fromFolder, string toFolder)Parameters
| Type | Name | Description |
|---|---|---|
| string | fromFolder | Folder as source of copying files |
| string | toFolder | Target folder which will contain files of both folders |
ReadToc(string)
Read toc.yml and return info in it
Declaration
public static Dictionary<string, Dictionary<string, string>> ReadToc(string tocPath)Parameters
| Type | Name | Description |
|---|---|---|
| string | tocPath |
Returns
| Type | Description |
|---|---|
| System.Collections.Generic.Dictionary<,><string, System.Collections.Generic.Dictionary<,><string, string>> |
Save(string)
Save group of files into folder
Declaration
public void Save(string folderPath)Parameters
| Type | Name | Description |
|---|---|---|
| string | folderPath |