Add Xml documentation to exposed methods and classes. #1275
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
-Added comments for ApiResponse. -Added comments for most of the attributes. -Added comments for RestService.
-Added comments to MultipartItems. -Added comments to Refit settings.
-Added comments to the IHttpContentSerializer interface.
|
Thanks! |
|
This pull request has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs. |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
What kind of change does this PR introduce?
Xml Docs on publicly exposed classes and methods.
What is the current behavior?
Most of the classes and methods you would use when using Refit have no Xml docs. Related issue: #1274
What is the new behavior?
Developers using the library will now see comments when typing a class or method name, hovering over them, etc.
What might this PR break?
I can't see how adding comments could break something so nothing afaik.
Please check if the PR fulfills these requirements
Other information:
Let me know if I have missed something or if you see a comment that should be worded differently/is wrong !