feat: support doc comments in Motoko bindgen#634
Merged
christoph-dfinity merged 15 commits intomasterfrom Jul 8, 2025
Merged
Conversation
Click to see raw report |
d04c3da to
e298c4a
Compare
e298c4a to
b96a124
Compare
ilbertt
approved these changes
Jul 7, 2025
lwshang
approved these changes
Jul 7, 2025
This file contains hidden or 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
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.
Overview
Adds support for reflecting doc comments from Candid declaration files to the Motoko generated bindings.
Internally, it adds the
IDLMergedProgwhich is constructed when parsing the Candid declarations and is passed to the Motoko bindings generator. It containts the syntax types along with the associated comments, and it's traversed in parallel with the inner types by the binding generator.Follow-up PRs will add support for doc comments in the other bindings generators.
Closes #625.