Improve the jerry port api documents. (#4977)
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
This commit is contained in:
@@ -72,12 +72,6 @@ filetime_to_unix_time (LPFILETIME ft_p)
|
||||
return (double) (((LONGLONG) date.QuadPart - UNIX_EPOCH_IN_TICKS) / TICKS_PER_MS);
|
||||
} /* filetime_to_unix_time */
|
||||
|
||||
/**
|
||||
* Default implementation of jerry_port_local_tza.
|
||||
*
|
||||
* @return offset between UTC and local time at the given unix timestamp, if
|
||||
* available. Otherwise, returns 0, assuming UTC time.
|
||||
*/
|
||||
int32_t
|
||||
jerry_port_local_tza (double unix_ms)
|
||||
{
|
||||
@@ -115,11 +109,6 @@ jerry_port_local_tza (double unix_ms)
|
||||
return 0;
|
||||
} /* jerry_port_local_tza */
|
||||
|
||||
/**
|
||||
* Default implementation of jerry_port_current_time.
|
||||
*
|
||||
* @return milliseconds since Unix epoch
|
||||
*/
|
||||
double
|
||||
jerry_port_current_time (void)
|
||||
{
|
||||
|
||||
@@ -20,37 +20,20 @@
|
||||
#include <stdlib.h>
|
||||
#include <string.h>
|
||||
|
||||
/**
|
||||
* Normalize a file path.
|
||||
*
|
||||
* @return a newly allocated buffer with the normalized path if the operation is successful,
|
||||
* NULL otherwise
|
||||
*/
|
||||
jerry_char_t *
|
||||
jerry_port_path_normalize (const jerry_char_t *path_p, /**< input path */
|
||||
jerry_size_t path_size) /**< size of the path */
|
||||
jerry_port_path_normalize (const jerry_char_t *path_p, jerry_size_t path_size)
|
||||
{
|
||||
(void) path_size;
|
||||
|
||||
return (jerry_char_t *) _fullpath (NULL, path_p, _MAX_PATH);
|
||||
} /* jerry_port_path_normalize */
|
||||
|
||||
/**
|
||||
* Free a path buffer returned by jerry_port_path_normalize.
|
||||
*/
|
||||
void
|
||||
jerry_port_path_free (jerry_char_t *path_p)
|
||||
{
|
||||
free (path_p);
|
||||
} /* jerry_port_path_free */
|
||||
|
||||
/**
|
||||
* Get the end of the directory part of the input path.
|
||||
*
|
||||
* @param path_p: input zero-terminated path string
|
||||
*
|
||||
* @return offset of the directory end in the input path string
|
||||
*/
|
||||
jerry_size_t
|
||||
jerry_port_path_base (const jerry_char_t *path_p)
|
||||
{
|
||||
|
||||
@@ -80,11 +80,8 @@ jerry_port_init (void)
|
||||
}
|
||||
} /* jerry_port_init */
|
||||
|
||||
/**
|
||||
* Default implementation of jerry_port_sleep, uses 'Sleep'.
|
||||
*/
|
||||
void
|
||||
jerry_port_sleep (uint32_t sleep_time) /**< milliseconds to sleep */
|
||||
jerry_port_sleep (uint32_t sleep_time)
|
||||
{
|
||||
Sleep (sleep_time);
|
||||
} /* jerry_port_sleep */
|
||||
|
||||
Reference in New Issue
Block a user