FreeRTOS/coreMQTT
1
0
Fork 0
mirror of https://github.com/FreeRTOS/coreMQTT synced 2025-05-22 06:02:50 +08:00
Code Issues Releases Wiki Activity

Hygiene update of logging interface macro docs in config defaults (#33)

Browse Source
This commit is contained in:
Archit Aggarwal 2020-09-08 14:51:17 -07:00 committed by GitHub
parent 3b0958bb4d
commit 9fc6f76b6d
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 22 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
source/include/core_mqtt_config_defaults.h
View File

@ -98,9 +98,10 @@
* application-specific logging implementation that supports error logging. * application-specific logging implementation that supports error logging.
* *
* @note This logging macro is called in the MQTT library with parameters wrapped in * @note This logging macro is called in the MQTT library with parameters wrapped in
* double parentheses to be ISO C89/C90 standard compliant. For an example * double parentheses to be ISO C89/C90 standard compliant. For a reference
* implementation of the logging macros, refer to mqtt_config.h files in the MQTT * POSIX implementation of the logging macros, refer to core_mqtt_config.h files, and the
* demo folder and the reference implementation of the logging-stack in demos. * logging-stack in demos folder of the
* [AWS IoT Embedded C SDK repository](https://github.com/aws/aws-iot-device-sdk-embedded-C/tree/master).
* *
* <b>Default value</b>: Error logging is turned off, and no code is generated for calls * <b>Default value</b>: Error logging is turned off, and no code is generated for calls
* to the macro in the MQTT library on compilation. * to the macro in the MQTT library on compilation.
@ -117,9 +118,10 @@
* application-specific logging implementation that supports warning logging. * application-specific logging implementation that supports warning logging.
* *
* @note This logging macro is called in the MQTT library with parameters wrapped in * @note This logging macro is called in the MQTT library with parameters wrapped in
* double parentheses to be ISO C89/C90 standard compliant. For an example * double parentheses to be ISO C89/C90 standard compliant. For a reference
* implementation of the logging macros, refer to mqtt_config.h files in the MQTT * POSIX implementation of the logging macros, refer to core_mqtt_config.h files, and the
* demo folder and the reference implementation of the logging-stack in demos. * logging-stack in demos folder of the
* [AWS IoT Embedded C SDK repository](https://github.com/aws/aws-iot-device-sdk-embedded-C/tree/master).
* *
* <b>Default value</b>: Warning logs are turned off, and no code is generated for calls * <b>Default value</b>: Warning logs are turned off, and no code is generated for calls
* to the macro in the MQTT library on compilation. * to the macro in the MQTT library on compilation.
@ -136,9 +138,10 @@
* application-specific logging implementation that supports info logging. * application-specific logging implementation that supports info logging.
* *
* @note This logging macro is called in the MQTT library with parameters wrapped in * @note This logging macro is called in the MQTT library with parameters wrapped in
* double parentheses to be ISO C89/C90 standard compliant. For an example * double parentheses to be ISO C89/C90 standard compliant. For a reference
* implementation of the logging macros, refer to mqtt_config.h files in the MQTT * POSIX implementation of the logging macros, refer to core_mqtt_config.h files, and the
* demo folder and the reference implementation of the logging-stack in demos. * logging-stack in demos folder of the
* [AWS IoT Embedded C SDK repository](https://github.com/aws/aws-iot-device-sdk-embedded-C/tree/master).
* *
* <b>Default value</b>: Info logging is turned off, and no code is generated for calls * <b>Default value</b>: Info logging is turned off, and no code is generated for calls
* to the macro in the MQTT library on compilation. * to the macro in the MQTT library on compilation.
@ -155,9 +158,10 @@
* application-specific logging implementation that supports debug logging. * application-specific logging implementation that supports debug logging.
* *
* @note This logging macro is called in the MQTT library with parameters wrapped in * @note This logging macro is called in the MQTT library with parameters wrapped in
* double parentheses to be ISO C89/C90 standard compliant. For an example * double parentheses to be ISO C89/C90 standard compliant. For a reference
* implementation of the logging macros, refer to mqtt_config.h files in the MQTT * POSIX implementation of the logging macros, refer to core_mqtt_config.h files, and the
* demo folder and the reference implementation of the logging-stack in demos. * logging-stack in demos folder of the
* [AWS IoT Embedded C SDK repository](https://github.com/aws/aws-iot-device-sdk-embedded-C/tree/master).
* *
* <b>Default value</b>: Debug logging is turned off, and no code is generated for calls * <b>Default value</b>: Debug logging is turned off, and no code is generated for calls
* to the macro in the MQTT library on compilation. * to the macro in the MQTT library on compilation.

6
source/lexicon.txt
View File

@ -6,6 +6,7 @@ addtogroup
api api
apis apis
app app
aws
bool bool
br br
bytesreceived bytesreceived
@ -65,8 +66,10 @@ gettime
gettimefunction gettimefunction
gettimestampms gettimestampms
getunsubscribepacketsize getunsubscribepacketsize
github
headersize headersize
http http
https
ifndef ifndef
inc inc
incomingpacket incomingpacket
@ -76,6 +79,7 @@ initializeconnectinfo
initializesubscribeinfo initializesubscribeinfo
initializewillinfo initializewillinfo
int int
iot
isn isn
iso iso
keepaliveintervalsec keepaliveintervalsec
@ -185,6 +189,7 @@ pnetworkbuffer
pnetworkcontext pnetworkcontext
pnetworkinterface pnetworkinterface
pnewstate pnewstate
posix
ppacketid ppacketid
ppacketidentifier ppacketidentifier
ppacketinfo ppacketinfo
@ -245,6 +250,7 @@ remainingtimems
resending resending
reservestate reservestate
responsecode responsecode
sdk
searchstates searchstates
serializeack serializeack
serializeconnect serializeconnect