Apply field doc-comments to builder methods #146
Merged
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.
I noticed that the builder has support for explicitly provided comments, e.g. via
However, regular doccomments would be ignored even when no setter-specific
doc
attribute is provided. With this PR, the following is now possible:On the builder,
x(...)
will be documented with the regular doccomment,y(...)
is documented with the setter attribute as before andz(...)
remains undocumented, as before.When the builder emits
deprecated
functions, they also inherit the documentation. This was not previously the case.