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

Unified Diff: mojo/edk/system/core.h

Issue 847703006: Minor tweaks to API documentation and code comments. (Closed) Base URL: https://github.com/domokit/mojo.git@master
Patch Set: Removing extra space. 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
« no previous file with comments | « no previous file | mojo/public/c/system/buffer.h » ('j') | no next file with comments »
Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
Index: mojo/edk/system/core.h
diff --git a/mojo/edk/system/core.h b/mojo/edk/system/core.h
index 0ff9c01894d7894232e45a29cb5d4018143be376..2baa7210b11422db89b848e9d71675eb45047780 100644
--- a/mojo/edk/system/core.h
+++ b/mojo/edk/system/core.h
@@ -64,7 +64,14 @@ class MOJO_SYSTEM_IMPL_EXPORT Core {
// ---------------------------------------------------------------------------
- // System calls implementation:
+ // The following methods are essentially implementations of the Mojo Core
+ // functions of the Mojo API, with the C interface translated to C++ by
+ // "mojo/edk/embedder/entrypoints.cc". The best way to understand the contract
+ // of these methods is to look at the header files defining the corresponding
+ // API functions, referenced below.
+
+ // These methods correspond to the API functions defined in
+ // "mojo/public/c/system/functions.h":
MojoTimeTicks GetTimeTicksNow();
MojoResult Close(MojoHandle handle);
MojoResult Wait(MojoHandle handle,
@@ -77,6 +84,9 @@ class MOJO_SYSTEM_IMPL_EXPORT Core {
MojoDeadline deadline,
UserPointer<uint32_t> result_index,
UserPointer<MojoHandleSignalsState> signals_states);
+
+ // These methods correspond to the API functions defined in
+ // "mojo/public/c/system/message_pipe.h":
MojoResult CreateMessagePipe(
UserPointer<const MojoCreateMessagePipeOptions> options,
UserPointer<MojoHandle> message_pipe_handle0,
@@ -93,6 +103,9 @@ class MOJO_SYSTEM_IMPL_EXPORT Core {
UserPointer<MojoHandle> handles,
UserPointer<uint32_t> num_handles,
MojoReadMessageFlags flags);
+
+ // These methods correspond to the API functions defined in
+ // "mojo/public/c/system/data_pipe.h":
MojoResult CreateDataPipe(
UserPointer<const MojoCreateDataPipeOptions> options,
UserPointer<MojoHandle> data_pipe_producer_handle,
@@ -117,6 +130,9 @@ class MOJO_SYSTEM_IMPL_EXPORT Core {
MojoReadDataFlags flags);
MojoResult EndReadData(MojoHandle data_pipe_consumer_handle,
uint32_t num_bytes_read);
+
+ // These methods correspond to the API functions defined in
+ // "mojo/public/c/system/buffer.h":
MojoResult CreateSharedBuffer(
UserPointer<const MojoCreateSharedBufferOptions> options,
uint64_t num_bytes,
« no previous file with comments | « no previous file | mojo/public/c/system/buffer.h » ('j') | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698