capi: Clarify comments #635
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
Codecov Report
@@ Coverage Diff @@
## master #635 +/- ##
=======================================
Coverage 98.36% 98.36%
=======================================
Files 69 69
Lines 9622 9622
=======================================
Hits 9465 9465
Misses 157 157 |
axic
reviewed
Nov 4, 2020
include/fizzy/fizzy.h
Outdated
| /// Takes ownership of module, i.e. @p module is invalidated after this call. | ||
| /// Takes ownership of module, i.e. fizzy_free_module must not be called after this call. | ||
| /// For simplicity module cannot be shared among several instances (calling fizzy_instatiate more | ||
| /// than once with the same module is not allowed), but after fizzy_instantiate functions querying |
There was a problem hiding this comment.
"is not allowed" -> "results in undefined behaviour" ?
axic
reviewed
Nov 4, 2020
include/fizzy/fizzy.h
Outdated
| /// Takes ownership of module, i.e. @p module is invalidated after this call. | ||
| /// Takes ownership of module, i.e. fizzy_free_module must not be called after this call. | ||
| /// For simplicity module cannot be shared among several instances (calling fizzy_instatiate more | ||
| /// than once with the same module is not allowed), but after fizzy_instantiate functions querying |
chfast
reviewed
Nov 5, 2020
include/fizzy/fizzy.h
Outdated
| @@ -165,7 +165,10 @@ bool fizzy_find_exported_function( | |||
| const FizzyModule* module, const char* name, uint32_t* out_func_idx); | |||
|
|
|||
| /// Instantiate a module. | |||
| /// Takes ownership of module, i.e. @p module is invalidated after this call. | |||
| /// Takes ownership of module, i.e. fizzy_free_module must not be called after this call. | |||
There was a problem hiding this comment.
Suggested change
| /// Takes ownership of module, i.e. fizzy_free_module must not be called after this call. | |
| /// The instance takes ownership of the module, i.e. fizzy_free_module must not be called on the module after this call. |
include/fizzy/fizzy.h
Outdated
| @@ -165,7 +165,10 @@ bool fizzy_find_exported_function( | |||
| const FizzyModule* module, const char* name, uint32_t* out_func_idx); | |||
|
|
|||
| /// Instantiate a module. | |||
| /// Takes ownership of module, i.e. @p module is invalidated after this call. | |||
| /// Takes ownership of module, i.e. fizzy_free_module must not be called after this call. | |||
| /// For simplicity module cannot be shared among several instances (calling fizzy_instatiate more | |||
There was a problem hiding this comment.
Suggested change
| /// For simplicity module cannot be shared among several instances (calling fizzy_instatiate more | |
| /// For simplicity a module cannot be shared among several instances (calling fizzy_instatiate more |
chfast
approved these changes
Nov 6, 2020
|
Squashed. |
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.