Fix Doxygen and fix comments

FreeRTOS · Oct 22, 2024 · 6ae9093 · 6ae9093
1 parent d3b3c8e
commit 6ae9093
Show file tree

Hide file tree

Showing 3 changed files with 12 additions and 10 deletions.
diff --git a/.github/.cSpellWords.txt b/.github/.cSpellWords.txt
@@ -20,6 +20,7 @@ DLIBRARY
 DNDEBUG
 DUNITTEST
 DUNITY
+getbytesinmqttvec
 getpacketid
 isystem
 lcov
@@ -34,6 +35,7 @@ NONDET
 pylint
 pytest
 pyyaml
+serializemqttvec
 sinclude
 UNACKED
 unpadded

diff --git a/source/core_mqtt.c b/source/core_mqtt.c
@@ -92,7 +92,7 @@
 
 struct MQTTVec
 {
-    TransportOutVector_t pVector;  /**< Pointer to transport vector. USER SHOULD NOT ACCESS THIS DIRECTLY - IT IS AN INTERNAL DETAIL AND CAN CHANGE. */
+    TransportOutVector_t pVector; /**< Pointer to transport vector. USER SHOULD NOT ACCESS THIS DIRECTLY - IT IS AN INTERNAL DETAIL AND CAN CHANGE. */
 };
 
 /*-----------------------------------------------------------*/

diff --git a/source/include/core_mqtt.h b/source/include/core_mqtt.h
@@ -660,7 +660,7 @@ MQTTStatus_t MQTT_CheckConnectStatus( MQTTContext_t * pContext );
  * MQTTPublishClearAllFailed if on a clean session connection, clearing all the
  * previously copied publishes fails
  * MQTTPublishRetrieveFailed if on an unclean session connection, the copied
- * publishes are not retrieved successfuly for retransmission
+ * publishes are not retrieved successfully for retransmission
  * #MQTTSuccess otherwise.
  *
  * @note This API may spend more time than provided in the timeoutMS parameters in
@@ -1247,24 +1247,24 @@ const char * MQTT_Status_strerror( MQTTStatus_t status );
 /* @[declare_mqtt_status_strerror] */
 
 /**
- * @brief Get the bytes in an array of #MQTTVec_t which can store the whole array as a an MQTT packet when calling MQTT_SerializeMQTTVec( void * pAllocatedMem, MQTTVec_t *pVec, size_t len ) function.
+ * @brief Get the bytes in an array of #MQTTVec which can store the whole array as a an MQTT packet when calling MQTT_SerializeMQTTVec( void * pAllocatedMem, MQTTVec_t *pVec, size_t len ) function.
  *
- * @param[in] pVec The #MQTTVec_t array.
- * @param[in] len The length of the #MQTTVec_t array.
+ * @param[in] pVec The #MQTTVec array.
+ * @param[in] len The length of the #MQTTVec array.
  *
- * @return The bytes in the provided MQTTVec_t array which can then be used to set aside memory to be used with MQTT_SerializeMQTTVec( void * pAllocatedMem, MQTTVec_t *pVec, size_t len ) function.
+ * @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, size_t len ) function.
  */
 /* @[declare_mqtt_getbytesinmqttvec] */
 size_t MQTT_GetBytesInMQTTVec( MQTTVec_t * pVec,
                                size_t len );
 /* @[declare_mqtt_getbytesinmqttvec] */
 
 /**
- * @brief Serialize the bytes in an array of #MQTTVec_t in the provided \p pAllocatedMem
+ * @brief Serialize the bytes in an array of #MQTTVec in the provided \p pAllocatedMem
  *
- * @param[in] pAllocatedMem Memory in which to serialize the data in the #MQTTVec_t array. It must be of size provided by MQTT_GetBytesInMQTTVec( MQTTVec_t *pVec, size_t len ).
- * @param[in] pVec The #MQTTVec_t array.
- * @param[in] len The length of the #MQTTVec_t array.
+ * @param[in] pAllocatedMem Memory in which to serialize the data in the #MQTTVec array. It must be of size provided by MQTT_GetBytesInMQTTVec( MQTTVec_t *pVec, size_t len ).
+ * @param[in] pVec The #MQTTVec array.
+ * @param[in] len The length of the #MQTTVec array.
  */
 /* @[declare_mqtt_serializemqttvec] */
 void MQTT_SerializeMQTTVec( uint8_t * pAllocatedMem,