Maintaining Documentation: Difference between revisions
From PMDOWiki
tooltip mention |
No edit summary |
||
| Line 1: | Line 1: | ||
The documentation for all classes in PMDC, RogueEssence, and RogueElements can be found in [https://github.com/audinowho/DumpAsset/tree/master/Editor/Docs 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. | The documentation for all classes in PMDC, RogueEssence, and RogueElements can be found in [https://github.com/audinowho/DumpAsset/tree/master/Editor/Docs 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 | |||
Revision as of 02:32, 20 March 2023
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
