search

Azure / azure-iot-middleware-freertos

Azure IoT Middleware for FreeRTOS
https://azure.github.io/azure-iot-middleware-freertos/
MIT License
80 stars 24 forks source link

Add comments distinguishing middleware vs embedded includes #194

Closed danewalton closed 3 years ago

danewalton commented 3 years ago

Currently the headers for middleware and embedded looks very similar and it isn't immediately apparent the difference.

Example: az_iot_hub_client.h vs azure_iot_hub_client.h https://github.com/Azure/azure-iot-middleware-freertos/blob/7e5cb01aa29e999548ace981e8cff288d66b93ca/source/include/azure_iot_hub_client.h#L26

We should add some comments like

#include "azure_iot_mqtt_port.h"
#include "azure_iot_transport_interface.h"

/* Embedded SDK includes */
#include "azure/az_core.h"
#include "azure/iot/az_iot_hub_client.h"