Tutorial:Maintaining Documentation

The documentation for all classes in PMDC, RogueEssence, and RogueElements can be found in Editor/Docs. They are updated manually by building the projects in debug mode and copying the XMLs from their output directory to the target location. They are used in the editor as the source of its tooltips.

Documents are generated using the <DocumentationFile> MSBuild Tag in debug mode https://learn.microsoft.com/en-us/dotnet/core/project-sdk/msbuild-props

It extracts the following tags from the C# documentation: https://learn.microsoft.com/en-us/dotnet/csharp/language-reference/xmldoc/recommended-tags

Wiki Maintenance

Run the Wiki Sync script to generate wiki-ready pages of common functions used for lua scripting. They are output to https://github.com/audinowho/PMDODump/tree/master/DataAsset/Docs DataAsset/Docs]