Standardization of some function headers.

This commit is contained in:
Gregory Nutt
2018-03-13 09:52:27 -06:00
parent c268288c17
commit b54ffe858a
488 changed files with 2008 additions and 2007 deletions

View File

@@ -93,7 +93,7 @@ void net_lockinitialize(void);
* Convert a decisecond value to a struct timeval. Needed by getsockopt()
* to report timeout values.
*
* Parameters:
* Input Parameters:
* dsec The decisecond value to convert
* tv The struct timeval to receive the converted value
*
@@ -112,7 +112,7 @@ void net_dsec2timeval(uint16_t dsec, FAR struct timeval *tv);
* Description:
* Convert a decisecond value to a system clock ticks. Used by IGMP logic.
*
* Parameters:
* Input Parameters:
* dsec The decisecond value to convert
*
* Returned Value:
@@ -129,7 +129,7 @@ unsigned int net_dsec2tick(int dsec);
* Convert a struct timeval to deciseconds. Needed by setsockopt() to
* save new timeout values.
*
* Parameters:
* Input Parameters:
* tv - The struct timeval to convert
* remainder - Determines how to handler the microsecond remainder
*
@@ -158,7 +158,7 @@ unsigned int net_timeval2dsec(FAR struct timeval *tv,
* there might not be additional '1' bits following the firs '0', but that
* will be a malformed netmask.
*
* Parameters:
* Input Parameters:
* mask Points to an IPv6 netmask in the form of uint16_t[8]
*
* Returned Value:
@@ -178,7 +178,7 @@ uint8_t net_ipv6_mask2pref(FAR const uint16_t *mask);
* Convert a IPv6 prefix length to a network mask. The prefix length
* specifies the number of MS bits under mask (0-128)
*
* Parameters:
* Input Parameters:
* preflen - Determines the width of the netmask (in bits). Range 0-128
* mask - The location to return the netmask.
*