Add documentation to generated code #2133
Merged
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
Motivation: The generated code doesn't consistently include documentation from the source IDL. It also doesn't explain the difference between each of the generated protocols and when to use them. Modifications: Add documentation to the generated code, and where possible, also include any documentation from the source IDL. Result: Better documented generated code
rnro
reviewed
Nov 27, 2024
|
|
||
| private func explodedDocs(for method: MethodDescriptor) -> String { | ||
| let summary = "/// Call the \"\(method.name.base)\" method." | ||
| var parameters = """ |
There was a problem hiding this comment.
How often is this code called? Often enough to want to use something more efficient than +=?
There was a problem hiding this comment.
Infrequently, it's only used at code generation time so not really concerned about this.
rnro
approved these changes
Nov 27, 2024
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.
Motivation:
The generated code doesn't consistently include documentation from the source IDL. It also doesn't explain the difference between each of the generated protocols and when to use them.
Modifications:
Add documentation to the generated code, and where possible, also include any documentation from the source IDL.
Result:
Better documented generated code