Add XML docs for exceptions that can be thrown by ModuleClient.SendEventAsync and DeviceClient.SendEventAsync

[Marusyk]

Added XML docs for exceptions that can be thrown by ModuleClient.SendEventAsync and DeviceClient.SendEventAsync
Please review.

Thank you in advance

Checklist

• I have read the contribution guidelines.
• I added or modified the existing tests to cover the change (we do not allow our test coverage to go down).
• This pull-request is submitted against the master branch.

Reference/Link to the issue solved with this PR (if any)

Fixes #2176

[abhipsaMisra]

Thank you for submitting this PR.
There are a couple of more exceptions that could be thrown from these APIs, would you mind adding the below text as well:

        /// <exception cref="IotHubCommunicationException">Thrown if the client encounters a transient retryable exception. </exception>
        /// <exception cref="TimeoutException">Thrown if the service does not respond to the request within the timeout specified for the operation.
        /// The timeout values are largely transport protocol specific. Check the corresponding transport settings to see if they can be configured.
        /// The operation timeout for the client can be set using <see cref="OperationTimeoutInMilliseconds"/>.</exception>
        /// <exception cref="OperationCanceledException">Thrown if the service does not respond to the request before the expiration of the passed <see cref="CancellationToken"/>.
        /// If a cancellation token is not supplied to the operation call, a cancellation token with an expiration time of 4 minutes is used.
        /// </exception>
        /// <exception cref="SocketException">Thrown if a socket error occurs.</exception>
        /// <exception cref="WebSocketException">Thrown if an error occurs when performing an operation on a WebSocket connection.</exception>
        /// <exception cref="IOException">Thrown if an I/O error occurs.</exception>
        /// <exception cref="ClosedChannelException">Thrown if the MQTT transport layer closes unexpectedly.</exception>
        /// <exception cref="IotHubException">Thrown if an error occurs when communicating with IoT Hub service.
        /// If <see cref="IotHubException.IsTransient"/> is set to <c>true</c> then it is a transient exception.
        /// If <see cref="IotHubException.IsTransient"/> is set to <c>false</c> then it is a non-transient exception.</exception>
        /// <remarks>
        /// In case of a transient issue, retrying the operation should work. In case of a non-transient issue, inspect the error details and take steps accordingly.
        /// Please note that the above list is not exhaustive.
        /// </remarks>

[Marusyk]

@abhipsaMisra done
please review

[drwill-ms]

One small wording change requested.

[drwill-ms]

/azp run

[azure-pipelines]

Azure Pipelines successfully started running 1 pipeline(s).

[drwill-ms]

It looks like there is a build failure due to some of the types referenced in the doc comments not being found. You'll need to add some using statements up top to make sure the types are known.

[drwill-ms]

/azp run

[azure-pipelines]

Azure Pipelines successfully started running 1 pipeline(s).

[Marusyk]

I can`t see the build error because - 401 - Uh-oh, you do not have access.

[drwill-ms]

I can`t see the build error because - 401 - Uh-oh, you do not have access.

No problem. It is an internal pipeline. The error is a failed test due to service throttling. I'm rerunning the failed pipelines. I'm sure it'll go through and then I'll merge it.

It is looking good at this point. Thank you very much for your quick responses along the way.