Skip to content

Commit d0671c4

Browse files
author
Zsolt Borbély
authored
Update the webpage (#4813)
JerryScript-DCO-1.0-Signed-off-by: Zsolt Borbély [email protected]
1 parent acdecfc commit d0671c4

11 files changed

+1952
-509
lines changed

01.CONFIGURATION.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ permalink: /configuration/
1111
# Configuration
1212

1313
JerryScript provides a large number of configuration options which can be used to enable or disable specific features, allowing users to fine tune the engine to best suit their needs.
14-
A configuration option's value can be changed either by providing specific C preprocessor definitions, by adding CMake defininitions, or by using the arguments of the `tools/build.py` script.
14+
A configuration option's value can be changed either by providing specific C preprocessor definitions, by adding CMake definitions, or by using the arguments of the `tools/build.py` script.
1515
This document lists the available configuration options, shows the configuration name for C, CMake, and python, and provides a brief description that explains the effect of the options.
1616

1717

02.API-REFERENCE.md

Lines changed: 1926 additions & 483 deletions
Large diffs are not rendered by default.

04.INTERNALS.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,7 @@ Argument combinations are limited to the following seven forms:
8888
## Literals
8989

9090
Literals are organized into groups whose represent various literal types. Having these groups consuming less space than assigning flag bits to each literal.
91-
(In the followings, the mentioned ranges represent those indicies which are greater than or equal to the left side and less than the right side of the range. For example a range between `ident_end` and `literal_end` fields of the byte-code header contains those indicies, which are greater than or equal to `ident_end`
91+
(In the followings, the mentioned ranges represent those indices which are greater than or equal to the left side and less than the right side of the range. For example a range between `ident_end` and `literal_end` fields of the byte-code header contains those indices, which are greater than or equal to `ident_end`
9292
and less than `literal_end`. If `ident_end` equals to `literal_end` the range is empty.)
9393

9494
The two major group of literals are _identifiers_ and _values_.
@@ -277,7 +277,7 @@ An object can be a conventional data object or a lexical environment object. Unl
277277

278278
[Lexical environments](http://www.ecma-international.org/ecma-262/5.1/#sec-10.2) are implemented as objects in JerryScript, since lexical environments contains key-value pairs (called bindings) like objects. This simplifies the implementation and reduces code size.
279279

280-
![Object/Lexicat environment structures]({{ site.github.url }}/img/ecma_object.png){: class="thumbnail center-block img-responsive" }
280+
![Object/Lexical environment structures]({{ site.github.url }}/img/ecma_object.png){: class="thumbnail center-block img-responsive" }
281281

282282
The objects are represented as following structure:
283283

05.PORT-API.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -82,8 +82,8 @@ typedef enum
8282
void jerry_port_log (jerry_log_level_t level, const char *fmt, ...);
8383
```
8484
85-
The `jerry_port_print_char` is currenlty not used by the jerry-core directly.
86-
However, it provides a port specifc way for `jerry-ext` components to print
85+
The `jerry_port_print_char` is currently not used by the jerry-core directly.
86+
However, it provides a port specific way for `jerry-ext` components to print
8787
information.
8888
8989
```c
@@ -294,7 +294,7 @@ void
294294
jerry_port_print_char (char c)
295295
{
296296
putchar (c);
297-
} /* jerr_port_print_char */
297+
} /* jerry_port_print_char */
298298
```
299299
300300
## Date

07.DEBUGGER.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -326,12 +326,12 @@ wait_for_source_callback (const jerry_char_t *resource_name_p, /**< resource nam
326326
327327
jerry_parse_options_t parse_options;
328328
parse_options.options = JERRY_PARSE_HAS_RESOURCE;
329-
parse_options.resource_name_p = resource_name_p;
330-
parse_options.resource_name_length = resource_name_size;
329+
parse_options.resource_name = jerry_create_string ((const jerry_char_t *) resource_name_p);
331330
332331
jerry_value_t ret_val = jerry_parse (source_p,
333332
source_size,
334333
&parse_options);
334+
jerry_release_value (parse_options.resource_name);
335335
336336
if (!jerry_value_is_error (ret_val))
337337
{

08.CODING-STANDARDS.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ is doing.
5656

5757
/* not a complete sentence */
5858

59-
/* A bad mulitiline
59+
/* A bad multiline
6060
comment. */
6161
```
6262

@@ -379,7 +379,7 @@ a = 6;
379379

380380
b = 7;
381381

382-
/* No newlines are allowed between control staments
382+
/* No newlines are allowed between control statements
383383
* and their code blocks. */
384384

385385
if (a > 6)
@@ -429,7 +429,7 @@ a=b+c;
429429
a = b+c;
430430
a += c + ( d );
431431
/* Introduce temporary variables or macros
432-
* if the expression is too long. Occures rarely.. */
432+
* if the expression is too long. Occurs rarely.. */
433433
a = b
434434
+ c;
435435
if ( a + b > 0 )

10.EXT-REFERENCE-HANDLER.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -151,7 +151,7 @@ jerryx_has_property_str (const jerry_value_t target_object,
151151
- `target_object` - object on which the property name is accessed
152152
- `name` - property name as an UTF-8 `char*`
153153
- return value
154-
- true, if the given property name exsits on the object
154+
- true, if the given property name exists on the object
155155
- false, if there is no such property name or there was an error accessing the property
156156
157157
**Example**
@@ -190,7 +190,7 @@ for this the following utility structures and methods are provided.
190190
Structure to define an array of properties with `name` and `value` fields which
191191
can be registered to a target object.
192192

193-
The engine must be initialied before specifying the `jerry_value_t` in the struct.
193+
The engine must be initialized before specifying the `jerry_value_t` in the struct.
194194

195195

196196
**Prototype**
@@ -219,7 +219,7 @@ successfully registered methods.
219219
This must be passed for the [jerryx_release_property_entry](#jerryx_release_property_entry) method
220220
after the property registration.
221221

222-
If any error occured during the property registration the `result` field of the structure
222+
If any error occurred during the property registration the `result` field of the structure
223223
must be manually released after processing the error value.
224224

225225
**Prototype**
@@ -403,7 +403,7 @@ Release all `jerry_value_t` in a `jerryx_property_entry` array based on a previo
403403
and also the error value (if any) in the `jerryx_register_result` structure.
404404
In case of a successful registration it is safe to call this method.
405405
406-
After the method call the `ęntries` array should not be used as all values are released.
406+
After the method call the `entries` array should not be used as all values are released.
407407
408408
**Prototype**
409409
@@ -413,7 +413,7 @@ jerryx_release_property_entry (const jerryx_property_entry entries[],
413413
const jerryx_register_result register_result);
414414
```
415415
416-
- `entires` - array of [jerryx_property_entry](#jerryx_property_entry).
416+
- `entries` - array of [jerryx_property_entry](#jerryx_property_entry).
417417
- `register_result` - result of a previous [jerryx_set_properties](#jerryx_set_properties) call.
418418
419419
**Example**
@@ -523,7 +523,7 @@ jerryx_handler_gc (const jerry_value_t func_obj_val, const jerry_value_t this_p,
523523

524524
Provide a `print` implementation for scripts. The routine converts all of its
525525
arguments to strings and outputs them char-by-char using
526-
`jerry_port_print_char`. The NUL character is output as "\u0000",
526+
`jerry_port_print_char`. The NULL character is output as "\u0000",
527527
other characters are output bytewise.
528528

529529
*Note*: This implementation does not use standard C `printf` to print its

12.EXT-REFERENCE-MODULE.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -267,7 +267,7 @@ symbols so that they may be called explicitly from within the application.
267267
#define JERRYX_NATIVE_MODULE(module_name, on_resolve_cb)
268268
```
269269

270-
- `module_name` - the name of the module without quotes. This value is used as the prefix for the registration and unregistration funtions. For example, when `module_name` is `example_module`, this results in the declaration of two functions `example_module_register()` and `example_module_unregister()`. These functions are declared global if support for library constructors/destructors is absent, allowing you to call them from other parts of the code by
270+
- `module_name` - the name of the module without quotes. This value is used as the prefix for the registration and unregistration functions. For example, when `module_name` is `example_module`, this results in the declaration of two functions `example_module_register()` and `example_module_unregister()`. These functions are declared global if support for library constructors/destructors is absent, allowing you to call them from other parts of the code by
271271
first forward-declaring them.
272272
- `on_resolve_cb` - the function of type `jerryx_native_module_on_resolve_t` that will be called when the module needs to be
273273
loaded.

13.DEBUGGER-TRANSPORT.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -110,7 +110,7 @@ typedef bool (*jerry_debugger_transport_receive_t) (struct jerry_debugger_transp
110110
111111
**Summary**
112112
113-
Add a new interface to the transporation interface chain. The interface
113+
Add a new interface to the transportation interface chain. The interface
114114
will be the first item of the interface chain.
115115
116116
**Prototype**
@@ -121,7 +121,7 @@ void jerry_debugger_transport_add (jerry_debugger_transport_header_t *header_p,
121121
size_t receive_message_header_size, size_t max_receive_message_size);
122122
```
123123

124-
- `header_p`: header of a transporation interface.
124+
- `header_p`: header of a transportation interface.
125125
- `send_message_header_size`: size of the outgoing message header, can be 0.
126126
- `max_send_message_size`: maximum outgoing message size supported by the interface.
127127
- `receive_message_header_size`: size of the incoming message header, can be 0.

15.MODULE-SYSTEM.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ Embedders wishing to use native builtin modules with ES6 imports can use the [Po
1717
## General
1818

1919
If a script contains import statements, then JerryScript will open and evaluate the the referenced modules before the main script runs, resolving and creating bindings for the referenced identifiers in the process.
20-
It is not necessary to use any specific filename extensions for modules, JerryScript will try to open the given file paths as they are, but will try to normalize them before doing so. The exact normalization process is dependant on the port implementation provided. It is the user's responsibility to verify that the given files are valid EcmaScript modules.
20+
It is not necessary to use any specific filename extensions for modules, JerryScript will try to open the given file paths as they are, but will try to normalize them before doing so. The exact normalization process is dependant on the port implementation provided. It is the user's responsibility to verify that the given files are valid ECMAScript modules.
2121

2222
main.js
2323

@@ -86,7 +86,7 @@ export var version = "1.0 (e92ae0fb)";
8686

8787
```js
8888
// module_2.js
89-
var featureName = "EcmaScript modules";
89+
var featureName = "ECMAScript modules";
9090
var year = 2018;
9191

9292
export function getFeatureDetails() {
@@ -96,7 +96,7 @@ export function getFeatureDetails() {
9696

9797
### Module namespace import statements
9898

99-
A module namespace object can be imported. In this case the local binding will contain an object holding the exported values of the module, including local exports and all indirect exports. Ambiguous exported names are exluded from the namespace object.
99+
A module namespace object can be imported. In this case the local binding will contain an object holding the exported values of the module, including local exports and all indirect exports. Ambiguous exported names are excluded from the namespace object.
100100

101101
```js
102102
import * as module from './module.js';

0 commit comments

Comments
 (0)