aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorAkos Kiss <akiss@inf.u-szeged.hu>2018-05-09 11:15:45 +0200
committerGitHub <noreply@github.com>2018-05-09 11:15:45 +0200
commitd6cf6342394783d32530a8a026e26ebce709aec5 (patch)
treed61a722296c36943f52d6ed189f172b5f3cda4e4 /docs
parenta1f71f89370484eda64b7ce8659d1f55e6c3c9fc (diff)
Refactor/fix/document the default port implementation (#2317)
- Various constructs could be expressed with simpler and/or more readable code. - The jerry_port_log implementation for the debugger case was prone to buffer overflow error. - Some documentation was still missing (even from jerryscript-port.h). JerryScript-DCO-1.0-Signed-off-by: Akos Kiss akiss@inf.u-szeged.hu
Diffstat (limited to 'docs')
-rw-r--r--docs/05.PORT-API.md3
1 files changed, 3 insertions, 0 deletions
diff --git a/docs/05.PORT-API.md b/docs/05.PORT-API.md
index 9a7cd82b..ce07cd1d 100644
--- a/docs/05.PORT-API.md
+++ b/docs/05.PORT-API.md
@@ -87,6 +87,7 @@ typedef struct
* CONFIG_DISABLE_DATE_BUILTIN is _not_ defined. Otherwise this function is
* not used.
*
+ * @param[out] tz_p time zone structure to fill.
* @return true - if success
* false - otherwise
*/
@@ -134,6 +135,8 @@ struct jerry_instance_t *jerry_port_get_current_instance (void);
* Note:
* This port function is called by jerry-core when JERRY_DEBUGGER is
* defined. Otherwise this function is not used.
+ *
+ * @param sleep_time milliseconds to sleep.
*/
void jerry_port_sleep (uint32_t sleep_time);
```