Fixed Function Prototype Descriptions for Error Codes

Added error codes that may be returned for element extractors

- Added error code OMRPORT_ERROR_INVALID_ARGUMENTS to reflect
  user input error and passing in non valid arguments.

Issue: eclipse-omr#4745

Signed-off-by: Haley Cao <haleycao88@hotmail.com>

port/common/omrsock.c

@@ -102,7 +102,8 @@ omrsock_getaddrinfo(struct OMRPortLibrary *portLibrary, char *node, char *servic
  * @param[in] handle The result structure returned by @ref omrsock_getaddrinfo.
  * @param[out] length The number of results.
  *
- * @return 0, if no errors occurred, otherwise return an error.
+ * @return 0, if no errors occurred, otherwise return an error. Error code values returned are
+ * \arg OMRPORT_ERROR_INVALID_ARGUMENTS when handle or index arguments are invalid.
  */
 int32_t
 omrsock_getaddrinfo_length(struct OMRPortLibrary *portLibrary, omrsock_addrinfo_t handle, uint32_t *length)
@@ -119,7 +120,8 @@ omrsock_getaddrinfo_length(struct OMRPortLibrary *portLibrary, omrsock_addrinfo_
  * @param[out] family The family at "index".
  * @param[in] index The index into the structure returned by @ref omrsock_getaddrinfo.
  *
- * @return 0, if no errors occurred, otherwise return an error.
+ * @return 0, if no errors occurred, otherwise return an error. Error code values returned are
+ * \arg OMRPORT_ERROR_INVALID_ARGUMENTS when handle or index arguments are invalid.
  */
 int32_t
 omrsock_getaddrinfo_family(struct OMRPortLibrary *portLibrary, omrsock_addrinfo_t handle, int32_t *family, int32_t index)
@@ -136,7 +138,8 @@ omrsock_getaddrinfo_family(struct OMRPortLibrary *portLibrary, omrsock_addrinfo_
  * @param[out] socktype The socket type at "index".
  * @param[in] index The index into the structure returned by @ref omrsock_getaddrinfo.
  *
- * @return 0, if no errors occurred, otherwise return an error.
+ * @return 0, if no errors occurred, otherwise return an error. Error code values returned are
+ * \arg OMRPORT_ERROR_INVALID_ARGUMENTS when handle or index arguments are invalid.
  */
 int32_t
 omrsock_getaddrinfo_socktype(struct OMRPortLibrary *portLibrary, omrsock_addrinfo_t handle, int32_t *socktype, int32_t index)
@@ -153,7 +156,8 @@ omrsock_getaddrinfo_socktype(struct OMRPortLibrary *portLibrary, omrsock_addrinf
  * @param[out] protocol The protocol family at "index".
  * @param[in] index The index into the structure returned by @ref omrsock_getaddrinfo.
  *
- * @return 0, if no errors occurred, otherwise return an error.
+ * @return 0, if no errors occurred, otherwise return an error. Error code values returned are
+ * \arg OMRPORT_ERROR_INVALID_ARGUMENTS when handle or index arguments are invalid.
  */
 int32_t
 omrsock_getaddrinfo_protocol(struct OMRPortLibrary *portLibrary, omrsock_addrinfo_t handle, int32_t *protocol, int32_t index)