From: Kevin Day <kevin@kevux.org>
Date: Tue, 11 Jul 2023 01:52:44 +0000 (-0500)
Subject: Cleanup: Fix socket documentation comment, where type is the actual socket type.
X-Git-Url: https://git.kevux.org/?a=commitdiff_plain;h=c336bda3e83a29a0a44b62330a7d4692d9fb63c3;p=fll

Cleanup: Fix socket documentation comment, where type is the actual socket type.

The socket.type is not the address type, it is the socket type.

The socket type is something like SOCK_STREAM or f_socket_type_stream_e.
---

diff --git a/level_0/f_socket/c/socket.h b/level_0/f_socket/c/socket.h
index 9ff3dc3..323a8e2 100644
--- a/level_0/f_socket/c/socket.h
+++ b/level_0/f_socket/c/socket.h
@@ -285,7 +285,7 @@ extern "C" {
  *   The socket.address may point to any valid structure, like "struct sockaddr", "struct sockaddr_un", or "struct sockaddr_in".
  *   The socket.domain must be assigned the desired domain (protocol family).
  *   The socket.protocol must be assigned the desired protocol.
- *   The socket.type must be assigned the desired type (address family).
+ *   The socket.type must be assigned the desired socket type.
  *   The socket.id will be updated with a file descriptor representing the created socket.
  *
  * @return