Skip to content

Improve the jerry port api documents.#4977

Merged
robertsipka merged 1 commit into
jerryscript-project:masterfrom
lygstate:port-api-comments
Dec 17, 2024
Merged

Improve the jerry port api documents.#4977
robertsipka merged 1 commit into
jerryscript-project:masterfrom
lygstate:port-api-comments

Conversation

@lygstate

@lygstate lygstate commented Feb 9, 2022

Copy link
Copy Markdown
Contributor

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 luoyonggang@gmail.com

@lygstate
lygstate force-pushed the port-api-comments branch 4 times, most recently from 4f46860 to 6fe006a Compare February 9, 2022 21:46
@LaszloLango LaszloLango added this to the Release 3.0.0 milestone Nov 13, 2024
@lygstate
lygstate force-pushed the port-api-comments branch 3 times, most recently from b9fad14 to c1ae526 Compare November 20, 2024 13:29
@LaszloLango LaszloLango mentioned this pull request Nov 25, 2024
19 tasks
@lygstate

lygstate commented Dec 2, 2024

Copy link
Copy Markdown
Contributor Author

@LaszloLango Any suggestion about this?

@LaszloLango LaszloLango left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@zherczeg zherczeg left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A lot of comments are removed. Why?

*/
static jerry_context_t *current_context_p = NULL;

/**

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why these are removed?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 luoyonggang@gmail.com

@robertsipka robertsipka left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@robertsipka
robertsipka merged commit b4bc230 into jerryscript-project:master Dec 17, 2024
@lygstate
lygstate deleted the port-api-comments branch December 17, 2024 09:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants