search

Azure-Samples / iot-middleware-freertos-samples

This repo has samples for dev kits using the Azure IoT middleware for FreeRTOS
MIT License
76 stars 46 forks source link

Add code documentation to the ADU structures and functions #222

Closed ewertons closed 2 years ago

ewertons commented 2 years ago

Purpose

Add code documentation to the ADU structures and functions

Does this introduce a breaking change?

[ ] Yes
[x] No

Pull Request Type

What kind of change does this Pull Request introduce?

[ ] Bugfix
[ ] Feature
[ ] Code style update (formatting, local variables)
[ ] Refactoring (no functional changes, no api changes)
[x] Documentation content changes
[ ] Other... Please describe:

How to Test

No tests necessary. This change is just in function and structure documentation.

danewalton commented 2 years ago

In azure_iot_adu_client.h:20 to 101, I believe we should remove the sample update request and manifest. Thoughts?

Yes I agree. People can check the unit tests now for examples.