Skip to content
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

Open
wants to merge 23 commits into
base: master
Choose a base branch
from
Open

Conversation

lolrobbe2
Copy link

@lolrobbe2 lolrobbe2 commented Jun 29, 2023

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?

  • Focus on a single fix or feature; remove any unrelated formatting or code changes
  • Add unit tests showing fix or feature works; all tests pass
  • Mention any related issues (put closes #XXXX in comment to auto-close issue when PR is merged)
  • Follow our coding conventions
  • Minimize the number of commits
  • 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!

@lolrobbe2
Copy link
Author

forgot to make a new sub branch on my fork :(

src/_premake_init.lua Outdated Show resolved Hide resolved
modules/vstudio/tests/cs2005/test_documentation_file.lua Outdated Show resolved Hide resolved
website/docs/documentationFile.md Outdated Show resolved Hide resolved
website/docs/documentationFile.md Outdated Show resolved Hide resolved
modules/vstudio/tests/cs2005/test_documentation_file.lua Outdated Show resolved Hide resolved
modules/vstudio/vs2005_dotnetbase.lua Outdated Show resolved Hide resolved
website/docs/documentationFile.md Outdated Show resolved Hide resolved
website/docs/documentationFile.md Outdated Show resolved Hide resolved
@nickclark2016
Copy link
Member

Currently away on travel. Will review when back near my computer.

Copy link
Member

@nickclark2016 nickclark2016 left a 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.

website/docs/documentationFile.md Outdated Show resolved Hide resolved
@lolrobbe2
Copy link
Author

Can somebody pls review?

@nickclark2016
Copy link
Member

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.

@lolrobbe2
Copy link
Author

changed the documentation capitalization and wording

@Jarod42
Copy link
Contributor

Jarod42 commented Oct 5, 2023

Missing documentation file for: documentationfile

Copy link
Member

@nickclark2016 nickclark2016 left a 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.

@lolrobbe2
Copy link
Author

lolrobbe2 commented Oct 5, 2023

my bad updated it and added it to the sidebar.js file. Also tested it using npm!

@lolrobbe2
Copy link
Author

lolrobbe2 commented Oct 14, 2023

Can you just show me the doc mistakes because i can't see it anymore! PLS

@nickclark2016
Copy link
Member

I think the issue with the build at this point is a mismatch in capitalization in the documentation (documentationFile.md vs documentationfile.md).

@lolrobbe2
Copy link
Author

changed the name to be documentationfile.md

Beernaert Robbe added 2 commits June 9, 2024 19:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

How about the Visual Studio's XmlDoc?
3 participants