Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Align wording of Init with porting guide #95

Merged
merged 2 commits into from
Oct 30, 2020

Conversation

muneebahmed10
Copy link
Contributor

Description:
Change note in documentation of MQTT_Init to explicitly mention which functions need the time function as the porting guide does.

@@ -231,8 +231,9 @@ typedef struct MQTTDeserializedInfo
* @note The #MQTTGetCurrentTimeFunc_t callback function must be defined. If
* there is no time implementation, it is the responsibility of the application
* to provide a dummy function to always return 0, and provide 0 timeouts for
* functions. This will ensure all time based functions will run for a single
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we add similar @note on top of these three functions as well ?

@muneebahmed10 muneebahmed10 merged commit 1bb7a23 into FreeRTOS:master Oct 30, 2020
@muneebahmed10 muneebahmed10 deleted the init-wording branch October 30, 2020 18:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants