This repository was archived by the owner on Mar 17, 2025. It is now read-only.
Add javadocs to Arduino API. #123
Merged
Conversation
This file contains hidden or 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
|
First step towards #30 |
| @@ -24,18 +24,97 @@ | |||
| #define FIREBASE_JSONBUFFER_SIZE 200 | |||
| #endif // FIREBASE_JSONBUFFER_SIZE | |||
|
|
|||
| /** | |||
| * Gateway class for Arduino clients to interact with the Firebase backend. | |||
There was a problem hiding this comment.
Maybe we should also precise there is the default Firebase instance and give an example.
s/Gateway/Main/
s/the Firebase backend/Firebase/
|
LGTM, just nits. |
| class FirebaseArduino { | ||
| public: | ||
| /** | ||
| * Must be called first. This sets the class up for use. |
There was a problem hiding this comment.
s/This sets the class up for use/This initialize the client with the given firebase host and credentials.
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Follows the style layed out here: http://www.stack.nl/~dimitri/doxygen/manual/docblocks.html
There are several options. I chose the javadoc style but am not particularly attached to it.