FreeRTOS/coreMQTT
1
0
Fork 0
mirror of https://github.com/FreeRTOS/coreMQTT synced 2025-10-24 02:42:36 +08:00
Code Issues Releases Wiki Activity

Use MQTT specific anchors for generic targets (#50)

Browse Source 
* Use MQTT specific anchors for porting guide

* Add mqtt specific anchors for log sections
This commit is contained in:
Muneeb Ahmed
2020-09-11 14:07:50 -07:00
committed by GitHub
parent b55c844858
commit 78f83cbfae
2 changed files with 11 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
docs/doxygen/pages.txt
View File

@@ -11,7 +11,7 @@ This MQTT library implements the client side of the MQTT 3.1.1 protocol. This li
- Operations on fixed buffers, so that applications may control their memory allocation strategy. - Operations on fixed buffers, so that applications may control their memory allocation strategy.
- Scalable performance and footprint. The [configuration settings](@ref core_mqtt_config) allow this library to be tailored to a system's resources. - Scalable performance and footprint. The [configuration settings](@ref core_mqtt_config) allow this library to be tailored to a system's resources.
Please see https://github.com/aws/aws-iot-device-sdk-embedded-C/tree/development/demos/mqtt for example code demonstrating integration with TLS. Please see https://github.com/aws/aws-iot-device-sdk-embedded-C/tree/master/demos/mqtt for example code demonstrating integration with TLS.
@section mqtt_memory_requirements Memory Requirements @section mqtt_memory_requirements Memory Requirements
@brief Memory requirements of the MQTT library. @brief Memory requirements of the MQTT library.
@@ -188,16 +188,16 @@ Some configuration settings are C pre-processor constants, and some are function
@section MQTT_MAX_CONNACK_RECEIVE_RETRY_COUNT @section MQTT_MAX_CONNACK_RECEIVE_RETRY_COUNT
@copydoc MQTT_MAX_CONNACK_RECEIVE_RETRY_COUNT @copydoc MQTT_MAX_CONNACK_RECEIVE_RETRY_COUNT
@section LogError @section mqtt_logerror LogError
@copydoc LogError @copydoc LogError
@section LogWarn @section mqtt_logwarn LogWarn
@copydoc LogWarn @copydoc LogWarn
@section LogInfo @section mqtt_loginfo LogInfo
@copydoc LogInfo @copydoc LogInfo
@section LogDebug @section mqtt_logdebug LogDebug
@copydoc LogDebug @copydoc LogDebug
*/ */

12
docs/doxygen/porting.txt
View File

@@ -3,11 +3,11 @@
@brief Guide for porting MQTT to a new platform. @brief Guide for porting MQTT to a new platform.
A port to a new platform must provide the following components: A port to a new platform must provide the following components:
1. [Configuration Macros](@ref porting_config) 1. [Configuration Macros](@ref mqtt_porting_config)
2. [Transport Interface](@ref porting_transport) 2. [Transport Interface](@ref mqtt_porting_transport)
3. [Time Function](@ref porting_time) 3. [Time Function](@ref mqtt_porting_time)
@section porting_config Configuration Macros @section mqtt_porting_config Configuration Macros
@brief Settings that must be set as macros in the config header `core_mqtt_config.h`, or passed in as compiler options. @brief Settings that must be set as macros in the config header `core_mqtt_config.h`, or passed in as compiler options.
@note If a custom configuration header `core_mqtt_config.h` is not provided, then the @ref MQTT_DO_NOT_USE_CUSTOM_CONFIG macro must be defined. @note If a custom configuration header `core_mqtt_config.h` is not provided, then the @ref MQTT_DO_NOT_USE_CUSTOM_CONFIG macro must be defined.
@@ -25,7 +25,7 @@ In addition, the following logging macros are used throughout the library:
- @ref LogInfo - @ref LogInfo
- @ref LogDebug - @ref LogDebug
@section porting_transport Transport Interface @section mqtt_porting_transport Transport Interface
@brief The MQTT library relies on an underlying transport interface API that must be implemented @brief The MQTT library relies on an underlying transport interface API that must be implemented
in order to send and receive packets on a network. in order to send and receive packets on a network.
@@ -56,7 +56,7 @@ struct NetworkContext {
}; };
@endcode @endcode
@section porting_time Time Function @section mqtt_porting_time Time Function
@brief The MQTT library relies on a function to generate millisecond timestamps, for the @brief The MQTT library relies on a function to generate millisecond timestamps, for the
purpose of calculating durations and timeouts, as well as maintaining the keep-alive mechanism purpose of calculating durations and timeouts, as well as maintaining the keep-alive mechanism
of the MQTT protocol. of the MQTT protocol.