Adds / updates API documentation #812
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
…t, RTC, SystemClock, some non-Sming (ESP) functions.
|
@riban-bw Brilliant job! Thanks a lot for your efforts. |
14 tasks
johndoe8967
added a commit
to johndoe8967/Sming
that referenced
this pull request
Dec 10, 2016
* upstream/develop: (21 commits) Added crash handler. Fixed/improved debugging information. (SmingHub#826) Enabled the SPIFFS. Fixed the HttpServer_Bootstrap example. (SmingHub#827) Added onDelivery callback for messages with QoS 1 or 2. (SmingHub#617) Backported changes from SmingRTOS. (SmingHub#825) Add FAST GPIO for CS pin and change pin numbering to start from 0 in MCP23S17 Lib (SmingHub#823) Fix issue SmingHub#709. Keep SPI_WR_BYTE_ORDER, SPI_RD_BYTE_ORDER, and SPI_CK_OUT_EDGE when upddating the SPI_USER reg (SmingHub#710) Fix stability and performance of websocket server (SmingHub#824) Fixed the SSL support for MQTT. Fixed Echo_Ssl sample. Feature/websocket client ssl (SmingHub#819) The latest spiffs is loaded as third-party module. (SmingHub#816) More efficient way to analyze errors. (SmingHub#821) Websocket client implementation for Sming (SmingHub#809) Simplified the compilation of custom PWM and Basic_HwPWM sample. (SmingHub#818) Removed test that is randomly braking on MacOS X travis machines. Adds / updates API documentation for: DateTime, Clock, Debug, NtpCient, RTC, SystemClock, some non-Sming (ESP) functions. (SmingHub#812) Fix/remove gdbstub (SmingHub#811) Fixes/freebsd (SmingHub#810) Proper timeout handling for Websockets (SmingHub#806) Added information about the SSL support. Fixed small typos. ... # Conflicts: # Sming/Makefile-project.mk
johndoe8967
added a commit
to johndoe8967/Sming
that referenced
this pull request
Dec 10, 2016
* upstream_develop: (43 commits) Added crash handler. Fixed/improved debugging information. (SmingHub#826) Enabled the SPIFFS. Fixed the HttpServer_Bootstrap example. (SmingHub#827) Added onDelivery callback for messages with QoS 1 or 2. (SmingHub#617) Backported changes from SmingRTOS. (SmingHub#825) Add FAST GPIO for CS pin and change pin numbering to start from 0 in MCP23S17 Lib (SmingHub#823) Fix issue SmingHub#709. Keep SPI_WR_BYTE_ORDER, SPI_RD_BYTE_ORDER, and SPI_CK_OUT_EDGE when upddating the SPI_USER reg (SmingHub#710) Fix stability and performance of websocket server (SmingHub#824) Fixed the SSL support for MQTT. Fixed Echo_Ssl sample. Feature/websocket client ssl (SmingHub#819) The latest spiffs is loaded as third-party module. (SmingHub#816) More efficient way to analyze errors. (SmingHub#821) Websocket client implementation for Sming (SmingHub#809) Simplified the compilation of custom PWM and Basic_HwPWM sample. (SmingHub#818) Removed test that is randomly braking on MacOS X travis machines. Adds / updates API documentation for: DateTime, Clock, Debug, NtpCient, RTC, SystemClock, some non-Sming (ESP) functions. (SmingHub#812) Fix/remove gdbstub (SmingHub#811) Fixes/freebsd (SmingHub#810) Proper timeout handling for Websockets (SmingHub#806) Added information about the SSL support. Fixed small typos. ... # Conflicts: # Sming/Makefile-project.mk # Sming/SmingCore/Network/HttpServer.cpp
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.
More APIdocumentation:
DateTime
Clock
Debug
NtpCient
RTC
SystemClock
Some elements of the SDK used by Sming that are insufficiently documented within the SDK source files.
(There are many more classes to document. This is another chunk of the ongoing effort to get each class documented.)
This pull request should only add or update API documentation in header files. There should be no change to the source code / API / implementation.