Add GenerateDocumentationFile to make summaries show up in IDEs #365
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Without `GenerateDocumentationFile` set to true, your great code summaries never make it to the developer using the nuget.
marcin-krystianc
approved these changes
Sep 23, 2024
marcin-krystianc
requested changes
Sep 23, 2024
There was a problem hiding this comment.
Hi @NielsPilgaard,
Thanks for raising this PR. Could you have a look at these build warnings/errors?
error CS1570: XML comment has badly formed XML -- 'Expected an end tag for element 'summary'.'
Absolutely, I'll have a look tonight 👍 |
1591 warns about public types missing documentation: https://learn.microsoft.com/en-us/dotnet/csharp/language-reference/compiler-messages/cs1591
|
I hope this is an acceptable approach, it was either ignoring warning |
marcin-krystianc
approved these changes
Sep 24, 2024
There was a problem hiding this comment.
I hope this is an acceptable approach, it was either ignoring warning
CS1591or adding summaries in over 1700 places 😅
Yeah, that makes sense.
Thank you!
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Without
GenerateDocumentationFileset to true, your great code summaries never make it to the developer using the nuget.