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

First run this command in the dotnet command line for PMDODump:

dotnet docfx metadata docfx.json --outputFormat mref

This will generate documentation files in DataAsset/Docs.

Then run the Doc Sync script to generate wiki-ready pages of common functions used for lua scripting. They are output to DataAsset/WIKI/Docs.

For game data, run the DataGenerator project with the following arguments:

-asset ../../../../DumpAsset/ -gen ../../../../DataAsset -wiki

This will dump all game data wiki pages to DataAsset/WIKI/Data

Finally, run Wiki Sync to send all documentation files to the wiki. You will need a working oauth access token. Save this to wiki_token.txt located next to the wiki_sync.py.