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

Unified Diff: util/mach/mach_message_server.h

Issue 806953004: MachMessageServer::Run(): correct documentation (Closed) Base URL: https://chromium.googlesource.com/crashpad/crashpad@master
Patch Set: Created 6 years 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 | no next file » | no next file with comments »
Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
Index: util/mach/mach_message_server.h
diff --git a/util/mach/mach_message_server.h b/util/mach/mach_message_server.h
index 4c2a322eb95e4713acc524d7c5c8f6c5ddcd6319..65de85c0cdc19146ee933eb4af18d98411dd064b 100644
--- a/util/mach/mach_message_server.h
+++ b/util/mach/mach_message_server.h
@@ -153,16 +153,16 @@ class MachMessageServer {
//! message larger than the receive buffer’s size.
//! \param[in] timeout_ms The maximum duration that this entire function will
//! run, in milliseconds. This may be #kMachMessageTimeoutNonblocking or
- //! #kMachMessageTimeoutWaitIndefinitely. When \a persistent is `true`,
- //! the timeout applies to the overall duration of this function, not to
- //! any individual `mach_msg()` call.
+ //! #kMachMessageTimeoutWaitIndefinitely. When \a persistent is
+ //! #kPersistent, the timeout applies to the overall duration of this
+ //! function, not to any individual `mach_msg()` call.
//!
- //! \return On success, `KERN_SUCCESS` (when \a persistent is `false`) or
- //! `MACH_RCV_TIMED_OUT` (when \a persistent is `true` and \a timeout_ms
- //! is not #kMachMessageTimeoutWaitIndefinitely). This function has no
- //! successful return value when \a persistent is `true` and \a timeout_ms
- //! is #kMachMessageTimeoutWaitIndefinitely. On failure, returns a value
- //! identifying the nature of the error.
+ //! \return On success, `KERN_SUCCESS` (when \a persistent is #kOneShot) or
+ //! `MACH_RCV_TIMED_OUT` (when \a persistent is #kOneShot and \a
+ //! timeout_ms is not #kMachMessageTimeoutWaitIndefinitely). This function
+ //! has no successful return value when \a persistent is #kPersistent and
+ //! \a timeout_ms is #kMachMessageTimeoutWaitIndefinitely. On failure,
+ //! returns a value identifying the nature of the error.
static mach_msg_return_t Run(Interface* interface,
mach_port_t receive_port,
mach_msg_options_t options,
« no previous file with comments | « no previous file | no next file » | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698