epics/epics-base
0
0
Fork 0
Code Issues Pull Requests Projects Wiki Activity

Doxygen annotation proofreading fixes in osiSock.h

Browse Source
This commit is contained in:
Brendan Chandler
2022-05-10 16:19:26 -05:00
committed by Andrew Johnson
parent f3dfb36117
commit 7cdc44434c
1 changed files with 4 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
modules/libcom/src/osi/osiSock.h
View File

@@ -281,6 +281,7 @@ LIBCOM_API void epicsStdCall osiSockRelease (void);
* \brief convert socket error numbers to a string
*
* There are several system functions which set errno on failure. This function
* converts that error number into a string describing the error.
*
* \param[out] pBuf Pointer to char array where the error string will be stored
* \param bufSize Length of the array pointed to by pBuf
@@ -294,7 +295,8 @@ LIBCOM_API void epicsSocketConvertErrorToString (
* \brief Convert the currently set errno to a string
*
* errno is a global integer that gets set when certain functions return an
* error. This function converts that error value into a human readable string.
* error. This function converts that error value into a string describing the
* error.
*
* \param[out] pBuf Pointer to char array where the error string will be stored
* \param bufSize Length of the array pointed to by pBuf
@@ -337,7 +339,7 @@ LIBCOM_API int epicsStdCall sockAddrAreIdentical
/*!
* \brief Add available broadcast addresses to a list
*
* Add available broadcast addresses to a list This routine is provided with
* Add available broadcast addresses to a list. This routine is provided with
* the address of an ELLLIST, a socket, and a match address. When the routine
* returns there will be one additional entry in the list for each network
* interface found that is up and isn't a loop back interface (match addr is