premake
add C# documentationFile feature
closes #359
What does this PR do?
this PR makes it possible to enable the xmlDocumentationFile in visualStudio C# projects.
<DocumentationFile> vs <GenerateDocumentationFile>
How does this PR change Premake's behavior?
No existing behavior should be changed, only functionality has been added.
Anything else we should know?
There are 2 ways of enabeling this new feature, either by an empty string "", or by specifying a custom dirrectory. the projectName will automaticcaly be appended to this path with the xml extension added.
when an empty string is entered the resulting filepath will be made consisting of the targetDir and the projectName with the xml extension appended to it.
this is the preffered method because visualstudio can by default only recognize when dll and xmlDocumentationFile are in the sam folder.
hacky ways that wher used before this feature solution to 359 'closed' Did you check all the boxes?
- [x] Focus on a single fix or feature; remove any unrelated formatting or code changes
- [x] Add unit tests showing fix or feature works; all tests pass
- [x] Mention any related issues (put
closes #XXXXin comment to auto-close issue when PR is merged) - [x] Follow our coding conventions
- [x] Minimize the number of commits
- [x] Align documentation to your changes
You can now support Premake on our OpenCollective. Your contributions help us spend more time responding to requests like these!
Can somebody pls review?
Please go through and clean up the documentation file. Unnecessary capitalization, spacing around slashes, some wording that's uncomfortable to read. I'm happy with the code, just want the docs to be a bit better.
my bad updated it and added it to the sidebar.js file. Also tested it using npm!
Can you just show me the doc mistakes because i can't see it anymore! PLS
I think the issue with the build at this point is a mismatch in capitalization in the documentation (documentationFile.md vs documentationfile.md).