Chromium Code Reviews
chromiumcodereview-hr@appspot.gserviceaccount.com (chromiumcodereview-hr) | Please choose your nickname with Settings | Help | Chromium Project | Gerrit Changes | Sign out
(1709)

Unified Diff: mojo/public/c/system/functions.h

Issue 847703006: Minor tweaks to API documentation and code comments. (Closed) Base URL: https://github.com/domokit/mojo.git@master
Patch Set: Clarifies comments on MojoTimeTicks and getter function Created 5 years, 11 months ago
Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.
Jump to:
View side-by-side diff with in-line comments
Download patch
Index: mojo/public/c/system/functions.h
diff --git a/mojo/public/c/system/functions.h b/mojo/public/c/system/functions.h
index 5e0a0c414df9dfd88afabb91e18c3ce75f86b11d..45f96b6f238fbb5eb8a1790447cc9434dc1ff8ba 100644
--- a/mojo/public/c/system/functions.h
+++ b/mojo/public/c/system/functions.h
@@ -9,8 +9,6 @@
#ifndef MOJO_PUBLIC_C_SYSTEM_FUNCTIONS_H_
#define MOJO_PUBLIC_C_SYSTEM_FUNCTIONS_H_
-// Note: This header should be compilable as C.
-
#include "mojo/public/c/system/system_export.h"
#include "mojo/public/c/system/types.h"
@@ -25,9 +23,15 @@ extern "C" {
// operation's success/failure. E.g., a separate |flags| parameter may control
// whether a given "in/out" parameter is used for input, output, or both.)
-// Platform-dependent monotonically increasing tick count representing "right
-// now." The resolution of this clock is ~1-15ms. Resolution varies depending
-// on hardware/operating system configuration.
+// Returns the amount of time, in units of microseconds, that has passed since
viettrungluu 2015/01/30 22:34:17 Generally, this is overly verbose.
ggowan 2015/01/30 23:17:12 OK, I made it shorter.
+// some undefined point in the past. The values are only meaningful relative to
+// other values obtained from the same device without an intervening system
+// restart. Such values are guaranteed to be weakly monotonically-increasing
+// with the passage of real time, meaning they will not always advance, but they
+// will never go backwards (unlike time values with a well-defined epoch).
viettrungluu 2015/01/30 22:34:17 As far as I know, time travel is still an impossib
ggowan 2015/01/30 23:17:12 If you're talking about a value obtained from a cl
+// Although the units are microseconds, the values should not be assumed to be
+// at that level of precision. The actual precision varies depending on hardware
+// and platform, and is typically in the range of ~1-15 ms.
MOJO_SYSTEM_EXPORT MojoTimeTicks MojoGetTimeTicksNow(void);
// Closes the given |handle|.
@@ -71,7 +75,7 @@ MOJO_SYSTEM_EXPORT MojoResult MojoClose(MojoHandle handle);
// end of a message pipe and the other end is closed).
//
// If there are multiple waiters (on different threads, obviously) waiting on
-// the same handle and signal, and that signal becomes is satisfied, all waiters
+// the same handle and signal, and that signal becomes satisfied, all waiters
// will be awoken.
MOJO_SYSTEM_EXPORT MojoResult
MojoWait(MojoHandle handle,

Powered by Google App Engine
This is Rietveld 408576698