Add code examples in doxygen manual #42
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
aggarw13
force-pushed
the
doc/add-code-examples
branch
2 times, most recently
from
008f03f to
3bba70f
Compare
n9wxu
approved these changes
Jul 22, 2021
aggarw13
force-pushed
the
doc/add-code-examples
branch
from
3bba70f to
3fa80be
Compare
aggarw13
force-pushed
the
doc/add-code-examples
branch
from
3fa80be to
499dbd8
Compare
archigup
reviewed
Jul 22, 2021
archigup
reviewed
Jul 22, 2021
Co-authored-by: Archit Gupta <[email protected]>
archigup
approved these changes
Jul 22, 2021
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Major Changes
This PR makes the major update of adding code examples for coreSNTP library APIs in doxygen documentation. This is done by providing an example POSIX application of using the library to setup an SNTP client, and adding references to the relevant parts of the example file in the doxygen documentation of APIs.
This PR also adds a mechanism to validate build of the POSIX example application through a CI check.
Minor Changes
size_table.htmlfor public visibility in README.md.