]> Kevux Git Server - fll/commitdiff
Cleanup: Fix socket documentation comment, where type is the actual socket type.
authorKevin Day <kevin@kevux.org>
Tue, 11 Jul 2023 01:52:44 +0000 (20:52 -0500)
committerKevin Day <kevin@kevux.org>
Tue, 11 Jul 2023 01:52:44 +0000 (20:52 -0500)
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.

level_0/f_socket/c/socket.h

index 9ff3dc3d67edeea2ab2f3d59a6c65fbcb421930f..323a8e2db2c7ac3231cf70dfd2508a1c55c23b3e 100644 (file)
@@ -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