mirror of
https://bitbucket.org/chromiumembedded/cef
synced 2025-06-05 21:39:12 +02:00
Update include/ comments to Doxygen formatting (see issue #3384)
See related guidelines in the issue.
This commit is contained in:
@ -40,76 +40,107 @@ extern "C" {
|
||||
#include "include/internal/cef_export.h"
|
||||
|
||||
///
|
||||
// Represents a wall clock time in UTC. Values are not guaranteed to be
|
||||
// monotonically non-decreasing and are subject to large amounts of skew.
|
||||
// Time is stored internally as microseconds since the Windows epoch (1601).
|
||||
//
|
||||
// This is equivalent of Chromium `base::Time` (see base/time/time.h).
|
||||
/// Represents a wall clock time in UTC. Values are not guaranteed to be
|
||||
/// monotonically non-decreasing and are subject to large amounts of skew.
|
||||
/// Time is stored internally as microseconds since the Windows epoch (1601).
|
||||
///
|
||||
/// This is equivalent of Chromium `base::Time` (see base/time/time.h).
|
||||
///
|
||||
typedef struct _cef_basetime_t {
|
||||
int64 val;
|
||||
} cef_basetime_t;
|
||||
|
||||
///
|
||||
// Time information. Values should always be in UTC.
|
||||
/// Time information. Values should always be in UTC.
|
||||
///
|
||||
typedef struct _cef_time_t {
|
||||
int year; // Four or five digit year "2007" (1601 to 30827 on
|
||||
// Windows, 1970 to 2038 on 32-bit POSIX)
|
||||
int month; // 1-based month (values 1 = January, etc.)
|
||||
int day_of_week; // 0-based day of week (0 = Sunday, etc.)
|
||||
int day_of_month; // 1-based day of month (1-31)
|
||||
int hour; // Hour within the current day (0-23)
|
||||
int minute; // Minute within the current hour (0-59)
|
||||
int second; // Second within the current minute (0-59 plus leap
|
||||
// seconds which may take it up to 60).
|
||||
int millisecond; // Milliseconds within the current second (0-999)
|
||||
///
|
||||
/// Four or five digit year "2007" (1601 to 30827 on Windows, 1970 to 2038 on
|
||||
/// 32-bit POSIX)
|
||||
///
|
||||
int year;
|
||||
|
||||
///
|
||||
/// 1-based month (values 1 = January, etc.)
|
||||
///
|
||||
int month;
|
||||
|
||||
///
|
||||
/// 0-based day of week (0 = Sunday, etc.)
|
||||
///
|
||||
int day_of_week;
|
||||
|
||||
///
|
||||
/// 1-based day of month (1-31)
|
||||
///
|
||||
int day_of_month;
|
||||
|
||||
///
|
||||
/// Hour within the current day (0-23)
|
||||
///
|
||||
int hour;
|
||||
|
||||
///
|
||||
/// Minute within the current hour (0-59)
|
||||
///
|
||||
int minute;
|
||||
|
||||
///
|
||||
/// Second within the current minute (0-59 plus leap seconds which may take
|
||||
/// it up to 60).
|
||||
///
|
||||
int second;
|
||||
|
||||
///
|
||||
/// Milliseconds within the current second (0-999)
|
||||
///
|
||||
int millisecond;
|
||||
} cef_time_t;
|
||||
|
||||
///
|
||||
// Converts cef_time_t to/from time_t. Returns true (1) on success and false (0)
|
||||
// on failure.
|
||||
/// Converts cef_time_t to/from time_t. Returns true (1) on success and false
|
||||
/// (0) on failure.
|
||||
///
|
||||
CEF_EXPORT int cef_time_to_timet(const cef_time_t* cef_time, time_t* time);
|
||||
CEF_EXPORT int cef_time_from_timet(time_t time, cef_time_t* cef_time);
|
||||
|
||||
///
|
||||
// Converts cef_time_t to/from a double which is the number of seconds since
|
||||
// epoch (Jan 1, 1970). Webkit uses this format to represent time. A value of 0
|
||||
// means "not initialized". Returns true (1) on success and false (0) on
|
||||
// failure.
|
||||
/// Converts cef_time_t to/from a double which is the number of seconds since
|
||||
/// epoch (Jan 1, 1970). Webkit uses this format to represent time. A value of 0
|
||||
/// means "not initialized". Returns true (1) on success and false (0) on
|
||||
/// failure.
|
||||
///
|
||||
CEF_EXPORT int cef_time_to_doublet(const cef_time_t* cef_time, double* time);
|
||||
CEF_EXPORT int cef_time_from_doublet(double time, cef_time_t* cef_time);
|
||||
|
||||
///
|
||||
// Retrieve the current system time. Returns true (1) on success and false (0)
|
||||
// on failure.
|
||||
/// Retrieve the current system time. Returns true (1) on success and false (0)
|
||||
/// on failure.
|
||||
///
|
||||
CEF_EXPORT int cef_time_now(cef_time_t* cef_time);
|
||||
|
||||
///
|
||||
// Retrieve the current system time.
|
||||
/// Retrieve the current system time.
|
||||
///
|
||||
CEF_EXPORT cef_basetime_t cef_basetime_now();
|
||||
|
||||
///
|
||||
// Retrieve the delta in milliseconds between two time values. Returns true (1)
|
||||
// on success and false (0) on failure.
|
||||
/// Retrieve the delta in milliseconds between two time values. Returns true (1)
|
||||
/// on success and false (0) on failure.
|
||||
//
|
||||
CEF_EXPORT int cef_time_delta(const cef_time_t* cef_time1,
|
||||
const cef_time_t* cef_time2,
|
||||
long long* delta);
|
||||
|
||||
///
|
||||
// Converts cef_time_t to cef_basetime_t. Returns true (1) on success and
|
||||
// false (0) on failure.
|
||||
/// Converts cef_time_t to cef_basetime_t. Returns true (1) on success and
|
||||
/// false (0) on failure.
|
||||
///
|
||||
CEF_EXPORT int cef_time_to_basetime(const cef_time_t* from, cef_basetime_t* to);
|
||||
|
||||
///
|
||||
// Converts cef_basetime_t to cef_time_t. Returns true (1) on success and
|
||||
// false (0) on failure.
|
||||
/// Converts cef_basetime_t to cef_time_t. Returns true (1) on success and
|
||||
/// false (0) on failure.
|
||||
///
|
||||
CEF_EXPORT int cef_time_from_basetime(const cef_basetime_t from,
|
||||
cef_time_t* to);
|
||||
|
Reference in New Issue
Block a user