Added and improved documentation (sort of finished) #111
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
Added some new documentation for functions and improved some existing documentation.
Added some new documentation for functions and improved some existing documentation.
Finished most of the function documentation.
R-e-t-u-r-n-N-u-l-l
changed the title
Some new examples, some improved examples; changed myClientClass to MyClientClass
yourWaifu
requested changes
Aug 28, 2018
source/documentation.html.md
Outdated
| public: | ||
| using SleepyDiscord::DiscordClient::DiscordClient; | ||
|
|
||
| void onMessage(SleepyDiscord::Message message) { |
source/documentation.html.md
Outdated
|
|
||
| ### sendMessage | ||
| #### Other Details | ||
| [Declared in `client.h`](https://github.com/NoNamer64/sleepy-discord/blob/master/include/sleepy_discord/client.h) and [defined in `endpoints.cpp`](https://github.com/NoNamer64/sleepy-discord/blob/master/include/sleepy_discord/endpoints.cpp) |
There was a problem hiding this comment.
source/documentation.html.md
Outdated
|
|
||
| void onMessage(SleepyDiscord::Message message) { | ||
| if (message.content == "rules") | ||
| uploadFile(message.channelID, "res/rules.txt", "These are the rules"); |
There was a problem hiding this comment.
This one line starts with 2 tabs and 2 spaces. The line above uses 4 spaces. same goes for the main function
source/documentation.html.md
Outdated
| The Message you just sent as a Message object | ||
|
|
||
| #### Other Details | ||
| [Declared in `client.h`](https://github.com/NoNamer64/sleepy-discord/blob/master/include/sleepy_discord/client.h) and [defined in `endpoints.cpp`](https://github.com/NoNamer64/sleepy-discord/blob/master/include/sleepy_discord/endpoints.cpp) |
There was a problem hiding this comment.
source/documentation.html.md
Outdated
| Returns ``true`` on success | ||
|
|
||
| #### Other Details | ||
| [Declared in `client.h`](https://github.com/NoNamer64/sleepy-discord/blob/master/include/sleepy_discord/client.h) and [defined in `endpoints.cpp`](https://github.com/NoNamer64/sleepy-discord/blob/master/include/sleepy_discord/endpoints.cpp) |
source/documentation.html.md
Outdated
| Returns ``true`` on success | ||
|
|
||
| #### Other Details | ||
| [Declared in `client.h`](https://github.com/NoNamer64/sleepy-discord/blob/master/include/sleepy_discord/client.h) and [defined in `endpoints.cpp`](https://github.com/NoNamer64/sleepy-discord/blob/master/include/sleepy_discord/endpoints.cpp) |
source/documentation.html.md
Outdated
| Returns ``true`` on success | ||
|
|
||
| #### Other Details | ||
| [Declared in `client.h`](https://github.com/NoNamer64/sleepy-discord/blob/master/include/sleepy_discord/client.h) and [defined in `endpoints.cpp`](https://github.com/NoNamer64/sleepy-discord/blob/master/include/sleepy_discord/endpoints.cpp) |
source/documentation.html.md
Outdated
| Returns an array of ``Role`` objects | ||
|
|
||
| #### Other Details | ||
| [Declared in `client.h`](https://github.com/NoNamer64/sleepy-discord/blob/master/include/sleepy_discord/client.h) and [defined in `endpoints.cpp`](https://github.com/NoNamer64/sleepy-discord/blob/master/include/sleepy_discord/endpoints.cpp) |
There was a problem hiding this comment.
404 error, I think you get the point, so I'm not going to keep going without continuing to point this out
source/documentation.html.md
Outdated
| bool unbanMember(Snowflake<Server> serverID, Snowflake<User> userID); | ||
| ``` | ||
|
|
||
| Bans a member from a server |
|
|
||
| ### editChannelPermissions | ||
| ```cpp | ||
| bool editChannelPermissions(Snowflake<Channel> channelID, std::string ID, int allow, int deny, std::string type); |
There was a problem hiding this comment.
You might want to give an example for this one
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.
Added some new documentation for functions and improved some existing documentation.