-
-
Notifications
You must be signed in to change notification settings - Fork 617
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
add C# documentationFile feature #2103
base: master
Are you sure you want to change the base?
Conversation
forgot to make a new sub branch on my fork :( |
Currently away on travel. Will review when back near my computer. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Overall, the code LGTM. Just a few comments on the documentation.
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. |
changed the documentation capitalization and wording |
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks like the docs are missing from the sidebar and such.
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). |
changed the name to be documentationfile.md |
(functional result stays the same)
closes #359
What does this PR do?
this PR makes it possible to enable the xmlDocumentationFile in visualStudio C# projects.
vs
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?
closes #XXXX
in comment to auto-close issue when PR is merged)You can now support Premake on our OpenCollective. Your contributions help us spend more time responding to requests like these!