-
Notifications
You must be signed in to change notification settings - Fork 78
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
Kdoc the Kord #729
base: main
Are you sure you want to change the base?
Kdoc the Kord #729
Conversation
I think for classes that only are 1:1 mappings of discord json models (like most things in |
Sounds good, I'll change my documenting style to that from now on |
core/src/main/kotlin/event/channel/thread/ThreadListSyncEvent.kt
Outdated
Show resolved
Hide resolved
# Conflicts: # core/src/main/kotlin/event/channel/TypingStartEvent.kt # core/src/main/kotlin/event/message/MessageBulkDeleteEvent.kt # core/src/main/kotlin/event/message/MessageDeleteEvent.kt # core/src/main/kotlin/event/message/ReactionAddEvent.kt # core/src/main/kotlin/event/message/ReactionRemoveAllEvent.kt # core/src/main/kotlin/event/message/ReactionRemoveEvent.kt
# Conflicts: # core/src/commonMain/kotlin/builder/kord/KordBuilder.kt # core/src/commonMain/kotlin/entity/Webhook.kt # core/src/commonMain/kotlin/event/channel/ChannelCreateEvent.kt # core/src/commonMain/kotlin/event/channel/ChannelDeleteEvent.kt # core/src/commonMain/kotlin/event/channel/ChannelUpdateEvent.kt # core/src/commonMain/kotlin/exception/EntityNotFoundException.kt
# Conflicts: # core/src/commonMain/kotlin/entity/Guild.kt # core/src/commonMain/kotlin/entity/Icon.kt # core/src/commonMain/kotlin/entity/PartialGuild.kt # core/src/commonMain/kotlin/entity/Role.kt # core/src/commonMain/kotlin/entity/Sticker.kt # core/src/commonMain/kotlin/entity/User.kt # core/src/commonMain/kotlin/event/channel/thread/ThreadListSyncEvent.kt # core/src/commonMain/kotlin/event/gateway/Events.kt # core/src/commonMain/kotlin/event/message/MessageBulkDeleteEvent.kt # core/src/commonMain/kotlin/event/message/MessageDeleteEvent.kt # core/src/commonMain/kotlin/event/message/ReactionAddEvent.kt # core/src/commonMain/kotlin/event/message/ReactionRemoveAllEvent.kt # core/src/commonMain/kotlin/event/message/ReactionRemoveEvent.kt
This PR aims to close #11 or at least tackle the main part of it, by documenting lots and lots of code :D
Anyone who wants to help is welcome to PR to this branch and hopefully we can document as much as possible.
This will remain as a draft for a long time most likely
Any
private
orinternal
classes/functions/variables will not be documented in this PRWhat has been documented?
Below is a list of the "parent packages" in each of Kords modules, this is how i categorize the completion of this PR.
These will be checked once complete
Common
Core
Rest
Voice