add C# documentationFile feature #2103
Conversation
|
forgot to make a new sub branch on my fork :( |
|
Currently away on travel. Will review when back near my computer. |
|
|
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)
it is in there |
| -- | ||
| -- tests/actions/vstudio/cs2005/test_documentation_file.lua | ||
| -- Test DocumentationFile feature Visual Studio 2005+ C# project. | ||
| -- Copyright (c) 2012-2023 Jason Perkins and the Premake project |
There was a problem hiding this comment.
yea it's been a while ;-) but iam gonna stick whit it!
| wks = test.createWorkspace() | ||
| configurations { "Debug", "Release" } | ||
| language "C#" | ||
| targetdir("test\\targetDir") |
There was a problem hiding this comment.
Possibly
| targetdir("test\\targetDir") | |
| targetdir("test/targetDir") |
website/docs/documentationfile.md
Outdated
|
|
||
| ### Availability ### | ||
|
|
||
| Premake 5.0 or later. |
There was a problem hiding this comment.
Not sure which beta we are currently to be more accurate.
There was a problem hiding this comment.
Should be beta3, so Premake 5.0 beta3 or later..
|
made it so that when you just want default behaviour aka true to be used you use documentationfile(true) instead of documentationfile "". i was thinking to allow custom file name when you provide an path wich end with .xml and is ofcoarse a valid path. would like to now your opion on this! |
* added C# documentationFile feature * wrote unit tests for C# documentationFile * removed null opt to not enable documentationFile * add documentationFile documentation * add documentationFile documentation * added some extra info for custom dir * implemented comments * fixed title * fixed spelling + addd test * fixed spelling + addd test * improved grammar / capitalization * changed styling of the documentation * changed docs to fit api * added MSFT links to See Also * fixed capitalization * changed wording/ capitalization of documentation * removed the slashes! * added documenationfile to the sidebar * Rename documentationFile.md to documentationfile.md * added support for newer <GenerateDocumentationFile> tag (functional result stays the same) * changed tests * changed default from documentationfile "" to documentationfile(true) * changed documentation to match! * changed availability in docs for documentationfile.md --------- Co-authored-by: robbe beernaert <[email protected]> Co-authored-by: Beernaert Robbe <[email protected]>
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 #XXXXin 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!