ipc: improve the documentation for some functions in unix_domain_socket_util.cc
This patch tries to improve the wording for the documentation of
MakeUnixAddrForPath() and CreateUnixDomainSocket() functions in
unix_domain_socket_util.cc, to hopefully make them a little bit more
clear.
BUG=None
[email protected]
Review URL: https://codereview.chromium.org/1785773002
Cr-Commit-Position: refs/heads/master@{#380584}
diff --git a/ipc/unix_domain_socket_util.cc b/ipc/unix_domain_socket_util.cc
index c69c5d8..414674c6 100644
--- a/ipc/unix_domain_socket_util.cc
+++ b/ipc/unix_domain_socket_util.cc
@@ -24,9 +24,10 @@
namespace {
-// Returns true on success, false otherwise. If successful, fills in
-// |unix_addr| with the appropriate data for the socket, and sets
-// |unix_addr_len| to the length of the data therein.
+// This function fills in |unix_addr| with the appropriate data for the socket,
+// and sets |unix_addr_len| to the length of the data therein.
+// Returns true on success, or false on failure (typically because |socket_name|
+// violated the naming rules).
bool MakeUnixAddrForPath(const std::string& socket_name,
struct sockaddr_un* unix_addr,
size_t* unix_addr_len) {
@@ -53,7 +54,8 @@
return true;
}
-// Returns a valid socket on success.
+// This functions creates a unix domain socket, and set it as non-blocking.
+// Returns a valid socket descriptor on success, or an invalid one otherwise.
base::ScopedFD CreateUnixDomainSocket() {
// Create socket.
base::ScopedFD fd(socket(AF_UNIX, SOCK_STREAM, 0));
