Improve the jerry port api documents. #4977
Merged
Conversation
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
lygstate
force-pushed
the
port-api-comments
branch
4 times, most recently
from
4f46860 to
6fe006a
Compare
lygstate
force-pushed
the
port-api-comments
branch
3 times, most recently
from
b9fad14 to
c1ae526
Compare
19 tasks
lygstate
force-pushed
the
port-api-comments
branch
from
c1ae526 to
f5003a7
Compare
|
@LaszloLango Any suggestion about this? |
zherczeg
reviewed
Dec 11, 2024
| @@ -27,13 +27,6 @@ | |||
| */ | |||
| static jerry_context_t *current_context_p = NULL; | |||
|
|
|||
| /** | |||
There was a problem hiding this comment.
Remove the comments in port impl, that's easily getting to in-consistence
Those already documented in header, document twice create a lot of inconsistence, and not updated. So just leave a single copy of the comment
There was a problem hiding this comment.
I agree with @lygstate, these comments should be place in the header file only.
Notable changes: - Remove the comments in port impl, that's easily getting to in-consistence - Sync the jerryscript-port.h and 05.PORT-API.md - Fixes the invalid comment in port codes JerryScript-DCO-1.0-Signed-off-by: Yonggang Luo [email protected]
lygstate
force-pushed
the
port-api-comments
branch
from
f5003a7 to
65f4057
Compare
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.
Notable changes:
JerryScript-DCO-1.0-Signed-off-by: Yonggang Luo [email protected]