search

Azure / azure-iot-sdk-c

A C99 SDK for connecting devices to Microsoft Azure IoT services
https://azure.github.io/azure-iot-sdk-c
Other
588 stars 740 forks source link

Add doxygen documentation for CONNECTION STATUS CALLBACK STATUS an REASON #2434

Closed ewertons closed 1 year ago

ewertons commented 1 year ago

Also include documentation for missing connection status reasons IOTHUB_CLIENT_CONNECTION_NO_PING_RESPONSE and IOTHUB_CLIENT_CONNECTION_QUOTA_EXCEEDED.

# Checklist - [x] I have read the [contribution guidelines] (https://github.com/Azure/azure-iot-sdk-c/blob/main/.github/CONTRIBUTING.md). - [ ] I added or modified the existing tests to cover the change (we do not allow our test coverage to go down). - If this is a modification that impacts the behavior of a public API - [ ] I edited the corresponding document in the `devdoc` folder and added or modified requirements. - I submitted this PR against the correct branch: - [x] This pull-request is submitted against the `main` branch. - [x] I have merged the latest `main` branch prior to submission and re-merged as needed after I took any feedback. - [x] I have squashed my changes into one with a clear description of the change. # Reference/Link to the issue solved with this PR (if any) # Description of the problem

The enums IOTHUB_CLIENT_CONNECTION_STATUS and IOTHUB_CLIENT_CONNECTION_STATUS_REASON do not have (doxygen) documentation in code.

Description of the solution

Added doxygen-style documentation for both enumerations.