api: Doxygenize comments for resolve functions #697
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
axic
reviewed
Jan 27, 2021
| /// @a imported_functions may be in any order, but must contain functions for all of the imported | ||
| /// function names defined in the module. | ||
| std::vector<ExternalFunction> resolve_imported_functions( | ||
| const Module& module, const std::vector<ImportedFunction>& imported_functions); | ||
|
|
||
| // Global that should be used by instantiate as import, identified by module and global name. | ||
| /// Global that should be used by instantiate as import, identified by module and global name. | ||
| struct ImportedGlobal |
There was a problem hiding this comment.
Do we want to also document the fields of ImportedFunction, ImportedGlobal, Instance? Maybe even if we do, we do not need to document very clear fields as this is mostly internal documentation.
axic
approved these changes
Jan 27, 2021
Codecov Report
@@ Coverage Diff @@
## master #697 +/- ##
=======================================
Coverage 99.31% 99.31%
=======================================
Files 72 72
Lines 10542 10542
=======================================
Hits 10470 10470
Misses 72 72
Flags with carried forward coverage won't be shown. Click here to find out more.
|
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.
No description provided.