Updated function brief for FreeRTOS_SignalSocket

tony-josi-aws · tony-josi-aws · commit 2cbe9002024b · 2022-12-08T05:16:23.000Z
diff --git a/source/FreeRTOS_Sockets.c b/source/FreeRTOS_Sockets.c
@@ -5136,6 +5136,9 @@ void * pvSocketGetSocketID( const ConstSocket_t xSocket )
  *        and return the value -pdFREERTOS_ERRNO_EINTR ( -4 ).
  *
  * @param[in] xSocket: The socket that will be signalled.
+ * 
+ * @return If xSocket is an invalid socket then -pdFREERTOS_ERRNO_EINVAL 
+ *         is returned. Else 0 is returned.
  */
     BaseType_t FreeRTOS_SignalSocket( Socket_t xSocket )
     {

Original file line number	Diff line number	Diff line change
`@@ -5136,6 +5136,9 @@ void * pvSocketGetSocketID( const ConstSocket_t xSocket )`
`5136`	`5136`	`* and return the value -pdFREERTOS_ERRNO_EINTR ( -4 ).`
`5137`	`5137`	`*`
`5138`	`5138`	`* @param[in] xSocket: The socket that will be signalled.`
	`5139`	`+ *`
	`5140`	`+ * @return If xSocket is an invalid socket then -pdFREERTOS_ERRNO_EINVAL`
	`5141`	`+ * is returned. Else 0 is returned.`
`5139`	`5142`	`*/`
`5140`	`5143`	`BaseType_t FreeRTOS_SignalSocket( Socket_t xSocket )`
`5141`	`5144`	`{`