Skip to content

Commit a709a7c

Browse files
kinkieyadij
andauthored
Add documenation to wrapper functions
Co-authored-by: Amos Jeffries <yadij@users.noreply.github.com>
1 parent cdecd37 commit a709a7c

1 file changed

Lines changed: 12 additions & 13 deletions

File tree

compat/socket.h

Lines changed: 12 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -18,24 +18,23 @@
1818

1919
#if _SQUID_WINDOWS_ || _SQUID_MINGW_
2020

21-
int
22-
xaccept(int s, struct sockaddr *a, socklen_t *l);
21+
/// Provide POSIX accept(2) API on MinGW and Visual Studio build environments
22+
int xaccept(int s, struct sockaddr *a, socklen_t *l);
2323

24-
int
25-
xbind(int s, const struct sockaddr * n, socklen_t l);
24+
/// Provide POSIX bind(2) API on MinGW and Visual Studio build environments
25+
int xbind(int s, const struct sockaddr * n, socklen_t l);
2626

27-
int
28-
xconnect(int s, const struct sockaddr * n, socklen_t l);
27+
/// Provide POSIX connect(2) API on MinGW and Visual Studio build environments
28+
int xconnect(int s, const struct sockaddr * n, socklen_t l);
2929

30-
int
31-
xclose(int fd);
30+
/// Provide POSIX close(2) API on MinGW and Visual Studio build environments
31+
int xclose(int fd);
3232

33-
struct hostent *
34-
xgethostbyname(const char *n);
33+
/// Provide POSIX gethostbyname(2) API on MinGW and Visual Studio build environments
34+
struct hostent *xgethostbyname(const char *n);
3535

36-
int
37-
xsetsockopt(int s, int l, int o, const void *v, socklen_t n);
38-
// for windows/mingw calls referring to INVALID_SOCKET, use setsockopt()
36+
/// Provide POSIX setsockopt(2) API on MinGW and Visual Studio build environments
37+
int xsetsockopt(int s, int l, int o, const void *v, socklen_t n);
3938

4039
#else /* !(_SQUID_WINDOWS_ || _SQUID_MINGW_) */
4140

0 commit comments

Comments
 (0)