Update doxygen comments for APIs

DakshitBabbar · aggarg · web-flow · commit 630ed98c0c1c · 2025-03-04T09:12:52.000+05:30
Co-authored-by: Gaurav-Aggarwal-AWS &lt;33462878+aggarg@users.noreply.github.com&gt;
diff --git a/source/include/core_mqtt.h b/source/include/core_mqtt.h
@@ -1228,7 +1228,7 @@ const char * MQTT_Status_strerror( MQTTStatus_t status );
 /**
  * @brief Get the bytes in a #MQTTVec pointer which can store the whole array as a an MQTT packet when calling MQTT_SerializeMQTTVec( void * pAllocatedMem, MQTTVec_t *pVec ) function.
  *
- * @param[in] pVec The #MQTTVec pointer given as input to the user defined #MQTTStorePacketForRetransmit callback function. Should not be NULL.
+ * @param[in] pVec The #MQTTVec pointer given as input to the user defined #MQTTStorePacketForRetransmit callback function. Must not be NULL.
  *
  * @return The bytes in the provided #MQTTVec array which can then be used to set aside memory to be used with MQTT_SerializeMQTTVec( void * pAllocatedMem, MQTTVec_t *pVec ) function.
  */

Original file line number	Diff line number	Diff line change
`@@ -1228,7 +1228,7 @@ const char * MQTT_Status_strerror( MQTTStatus_t status );`
`1228`	`1228`	`/**`
`1229`	`1229`	`* @brief Get the bytes in a #MQTTVec pointer which can store the whole array as a an MQTT packet when calling MQTT_SerializeMQTTVec( void * pAllocatedMem, MQTTVec_t *pVec ) function.`
`1230`	`1230`	`*`
`1231`		`- * @param[in] pVec The #MQTTVec pointer given as input to the user defined #MQTTStorePacketForRetransmit callback function. Should not be NULL.`
	`1231`	`+ * @param[in] pVec The #MQTTVec pointer given as input to the user defined #MQTTStorePacketForRetransmit callback function. Must not be NULL.`
`1232`	`1232`	`*`
`1233`	`1233`	`* @return The bytes in the provided #MQTTVec array which can then be used to set aside memory to be used with MQTT_SerializeMQTTVec( void * pAllocatedMem, MQTTVec_t *pVec ) function.`
`1234`	`1234`	`*/`