Update and improve API documentation#2952
Merged
dbatyai merged 1 commit intojerryscript-project:masterfrom Jul 10, 2019
Merged
Conversation
rerobika
reviewed
Jul 8, 2019
Member
rerobika
left a comment
rerobika
left a comment
There was a problem hiding this comment.
Nice examples, only a minor style issue.
| returns the number of bytes used for the string. | ||
| - This is **not** the number of bytes required to store the string. | ||
|
|
||
|
|
galpeter
force-pushed
the
doc_update_1
branch
2 times, most recently
from
ec63efe to
d2b5ab7
Compare
Contributor
Author
|
@rerobika I've did a bit of update (around the |
Member
|
Still LGTM. |
dbatyai
requested changes
Jul 9, 2019
| void *user_data_p); | ||
| ``` | ||
|
|
||
| - `object` - is current the JavaScript in the iteration. |
| jerry_release_value (func_val); | ||
| jerry_release_value (glob_obj); | ||
|
|
||
|
|
|
|
||
| ... // create or acquire value to set | ||
| // create or acquire value to set | ||
| // Fo example: |
| { | ||
| jerry_value_t test_property = jerry_create_string ((const jerry_char_t *) "DemoProp"); | ||
| jerry_value_t test_value = jerry_create_number (3); | ||
| /* By default all properties added to an object is enumerable. */ |
A few parts of the API documentation was not clear enough. Added extra details and examples. JerryScript-DCO-1.0-Signed-off-by: Peter Gal pgal.u-szeged@partner.samsung.com
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
4 participants
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.
A few parts of the API documentation was not clear enough.
Added extra details and examples.