YourWishes/jerryscript
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Fix links in API page

Browse Source
This commit is contained in:
Evgeny Gavrin
2015-06-14 00:40:47 +03:00
parent da4db65d1c
commit 3f842c5099
1 changed files with 36 additions and 36 deletions
Download Patch File Download Diff File Expand all files Collapse all files
03.api.md
+36 -36
View File
@@ -24,7 +24,7 @@ void jerry_init (jerry_flag_t flags);
- `JERRY_FLAG_EMPTY` - no flags, just initialize in default configuration. - `JERRY_FLAG_EMPTY` - no flags, just initialize in default configuration.
## See also ## See also
- [jerry_cleanup](/API#jerry_cleanup) - [jerry_cleanup]({{ site.baseurl }}/API#jerry_cleanup)
## Example ## Example
@@ -53,7 +53,7 @@ void jerry_cleanup (void)
{% endhighlight %} {% endhighlight %}
## See also ## See also
- [jerry_init](/API#jerry_init) - [jerry_init]({{ site.baseurl }}/API#jerry_init)
# jerry_parse # jerry_parse
@@ -72,7 +72,7 @@ bool jerry_parse (const char* source_p, size_t source_size)
- `source_size` - size of the string, in bytes. - `source_size` - size of the string, in bytes.
## See also ## See also
- [jerry_run](/API#jerry_run) - [jerry_run]({{ site.baseurl }}/API#jerry_run)
## Example ## Example
{% highlight cpp %} {% highlight cpp %}
@@ -104,7 +104,7 @@ jerry_completion_code_t jerry_run (void)
Returned completion code indicates whether run performed successfully (`JERRY_COMPLETION_CODE_OK`), or an unhandled JavaScript exception occurred (`JERRY_COMPLETION_CODE_UNHANDLED_EXCEPTION`). Returned completion code indicates whether run performed successfully (`JERRY_COMPLETION_CODE_OK`), or an unhandled JavaScript exception occurred (`JERRY_COMPLETION_CODE_UNHANDLED_EXCEPTION`).
## See also ## See also
- [jerry_parse](/API#jerry_parse) - [jerry_parse]({{ site.baseurl }}/API#jerry_parse)
## Example ## Example
@@ -161,11 +161,11 @@ typedef struct jerry_api_value_t
{% endhighlight %} {% endhighlight %}
## See also ## See also
- [jerry_api_string_t](/API#jerry_api_string_t) - [jerry_api_string_t]({{ site.baseurl }}/API#jerry_api_string_t)
- [jerry_api_object_t](/API#jerry_api_object_t) - [jerry_api_object_t]({{ site.baseurl }}/API#jerry_api_object_t)
- [jerry_api_eval](/API#jerry_api_eval) - [jerry_api_eval]({{ site.baseurl }}/API#jerry_api_eval)
- [jerry_api_call_function](/API#jerry_api_call_function) - [jerry_api_call_function]({{ site.baseurl }}/API#jerry_api_call_function)
- [jerry_api_construct_object](/API#jerry_api_construct_object) - [jerry_api_construct_object]({{ site.baseurl }}/API#jerry_api_construct_object)
# jerry_api_eval # jerry_api_eval
@@ -191,8 +191,8 @@ jerry_api_eval (const char *source_p,
- `retval_p` - value, returned by `eval` (output parameter). - `retval_p` - value, returned by `eval` (output parameter).
## See also ## See also
- [jerry_api_create_external_function](/API#jerry_api_create_external_function) - [jerry_api_create_external_function]({{ site.baseurl }}/API#jerry_api_create_external_function)
- [jerry_api_value_t](/API#jerry_api_value_t) - [jerry_api_value_t]({{ site.baseurl }}/API#jerry_api_value_t)
## Example ## Example
{% highlight cpp %} {% highlight cpp %}
@@ -211,7 +211,7 @@ jerry_api_eval (const char *source_p,
## Summary ## Summary
Create new JavaScript string. Create new JavaScript string.
Upon the JavaScript string becomes unused, all pointers to it should be released using [jerry_api_release_string](/API#jerry_api_release_string). Upon the JavaScript string becomes unused, all pointers to it should be released using [jerry_api_release_string]({{ site.baseurl }}/API#jerry_api_release_string).
## Prototype ## Prototype
@@ -224,8 +224,8 @@ jerry_api_string_t* jerry_api_create_string (const char *v)
## See also ## See also
- [jerry_api_acquire_string](/API#jerry_api_acquire_string) - [jerry_api_acquire_string]({{ site.baseurl }}/API#jerry_api_acquire_string)
- [jerry_api_release_string](/API#jerry_api_release_string) - [jerry_api_release_string]({{ site.baseurl }}/API#jerry_api_release_string)
## Example ## Example
{% highlight cpp %} {% highlight cpp %}
@@ -243,7 +243,7 @@ jerry_api_string_t* jerry_api_create_string (const char *v)
## Summary ## Summary
Acquire new pointer to the string for usage outside of the engine. Acquire new pointer to the string for usage outside of the engine.
The acquired pointer should be released with [jerry_api_release_string](/API#jerry_api_release_string). The acquired pointer should be released with [jerry_api_release_string]({{ site.baseurl }}/API#jerry_api_release_string).
## Prototype ## Prototype
@@ -255,8 +255,8 @@ jerry_api_string_t* jerry_api_acquire_string (jerry_api_string_t *string_p)
- returned value - new pointer to the string. - returned value - new pointer to the string.
## See also ## See also
- [jerry_api_release_string](/API#jerry_api_release_string) - [jerry_api_release_string]({{ site.baseurl }}/API#jerry_api_release_string)
- [jerry_api_create_string](/API#jerry_api_create_string) - [jerry_api_create_string]({{ site.baseurl }}/API#jerry_api_create_string)
## Example ## Example
{% highlight cpp %} {% highlight cpp %}
@@ -286,8 +286,8 @@ void jerry_api_release_string (jerry_api_string_t *string_p)
{% endhighlight %} {% endhighlight %}
## See also ## See also
- [jerry_api_acquire_string](/API#jerry_api_acquire_string) - [jerry_api_acquire_string]({{ site.baseurl }}/API#jerry_api_acquire_string)
- [jerry_api_create_string](/API#jerry_api_create_string) - [jerry_api_create_string]({{ site.baseurl }}/API#jerry_api_create_string)
## Example ## Example
{% highlight cpp %} {% highlight cpp %}
@@ -310,7 +310,7 @@ void jerry_api_release_string (jerry_api_string_t *string_p)
## Summary ## Summary
Create new JavaScript object, like with `new Object()`. Create new JavaScript object, like with `new Object()`.
Upon the JavaScript object becomes unused, all pointers to it should be released using [jerry_api_release_object](/API#jerry_api_release_object). Upon the JavaScript object becomes unused, all pointers to it should be released using [jerry_api_release_object]({{ site.baseurl }}/API#jerry_api_release_object).
## Prototype ## Prototype
@@ -323,8 +323,8 @@ jerry_api_object_t* jerry_api_create_object (const char *v)
## See also ## See also
- [jerry_api_acquire_object](/API#jerry_api_acquire_object) - [jerry_api_acquire_object]({{ site.baseurl }}/API#jerry_api_acquire_object)
- [jerry_api_release_object](/API#jerry_api_release_object) - [jerry_api_release_object]({{ site.baseurl }}/API#jerry_api_release_object)
## Example ## Example
{% highlight cpp %} {% highlight cpp %}
@@ -342,7 +342,7 @@ jerry_api_object_t* jerry_api_create_object (const char *v)
## Summary ## Summary
Acquire new pointer to the object for usage outside of the engine. Acquire new pointer to the object for usage outside of the engine.
The acquired pointer should be released with [jerry_api_release_object](/API#jerry_api_release_object). The acquired pointer should be released with [jerry_api_release_object]({{ site.baseurl }}/API#jerry_api_release_object).
## Prototype ## Prototype
@@ -354,8 +354,8 @@ jerry_api_object_t* jerry_api_acquire_object (jerry_api_object_t *object_p)
- returned value - new pointer to the object. - returned value - new pointer to the object.
## See also ## See also
- [jerry_api_release_object](/API#jerry_api_release_object) - [jerry_api_release_object]({{ site.baseurl }}/API#jerry_api_release_object)
- [jerry_api_create_object](/API#jerry_api_create_object) - [jerry_api_create_object]({{ site.baseurl }}/API#jerry_api_create_object)
## Example ## Example
{% highlight cpp %} {% highlight cpp %}
@@ -385,8 +385,8 @@ void jerry_api_release_object (jerry_api_object_t *object_p)
{% endhighlight %} {% endhighlight %}
## See also ## See also
- [jerry_api_acquire_object](/API#jerry_api_acquire_object) - [jerry_api_acquire_object]({{ site.baseurl }}/API#jerry_api_acquire_object)
- [jerry_api_create_object](/API#jerry_api_create_object) - [jerry_api_create_object]({{ site.baseurl }}/API#jerry_api_create_object)
## Example ## Example
{% highlight cpp %} {% highlight cpp %}
@@ -419,9 +419,9 @@ bool jerry_api_is_function (const jerry_api_object_t* object_p)
- returned value - just boolean, indicating whether the specified object can be called as function. - returned value - just boolean, indicating whether the specified object can be called as function.
## See also ## See also
- [jerry_api_value_t](/API#jerry_api_value_t) - [jerry_api_value_t]({{ site.baseurl }}/API#jerry_api_value_t)
- [jerry_api_is_constructor](/API#jerry_api_is_constructor) - [jerry_api_is_constructor]({{ site.baseurl }}/API#jerry_api_is_constructor)
- [jerry_api_call_function](/API#jerry_api_call_function) - [jerry_api_call_function]({{ site.baseurl }}/API#jerry_api_call_function)
## Example ## Example
{% highlight cpp %} {% highlight cpp %}
@@ -453,9 +453,9 @@ bool jerry_api_is_constructor (const jerry_api_object_t* object_p)
- returned value - just boolean, indicating whether the specified object can be called as constructor. - returned value - just boolean, indicating whether the specified object can be called as constructor.
## See also ## See also
- [jerry_api_value_t](/API#jerry_api_value_t) - [jerry_api_value_t]({{ site.baseurl }}/API#jerry_api_value_t)
- [jerry_api_is_function](/API#jerry_api_is_function) - [jerry_api_is_function]({{ site.baseurl }}/API#jerry_api_is_function)
- [jerry_api_construct_object](/API#jerry_api_construct_object) - [jerry_api_construct_object]({{ site.baseurl }}/API#jerry_api_construct_object)
## Example ## Example
{% highlight cpp %} {% highlight cpp %}
@@ -496,11 +496,11 @@ jerry_api_call_function (jerry_api_object_t *function_object_p,
- specified object is a function object (see also jerry_api_is_function); - specified object is a function object (see also jerry_api_is_function);
- no unhandled exceptions were thrown in connection with the call. - no unhandled exceptions were thrown in connection with the call.
If call was performed successfully, returned value should be freed with [jerry_api_release_value](/API#jerry_api_release_value) just when it becomes unnecessary. If call was performed successfully, returned value should be freed with [jerry_api_release_value]({{ site.baseurl }}/API#jerry_api_release_value) just when it becomes unnecessary.
## See also ## See also
- [jerry_api_is_function](/API#jerry_api_is_function) - [jerry_api_is_function]({{ site.baseurl }}/API#jerry_api_is_function)
- [jerry_api_value_t](/API#jerry_api_value_t) - [jerry_api_value_t]({{ site.baseurl }}/API#jerry_api_value_t)
## Example ## Example
{% highlight cpp %} {% highlight cpp %}