Skip to content
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

Draft
wants to merge 17 commits into
base: main
Choose a base branch
from
Draft

Conversation

NoComment1105
Copy link
Contributor

@NoComment1105 NoComment1105 commented Nov 21, 2022

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 or internal classes/functions/variables will not be documented in this PR

What 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

    • Annotation
    • Entity
    • Exception
    • Ratelimit
    • Serialization
    • Outlying files
  • Core

    • Behavior
    • Builder
    • Cache
    • Entity
    • Event
    • Exception
    • Gateway
    • Live
    • Supplier
    • Outlying files
  • Rest

    • Builder
    • JSON
    • Ratelimit
    • Request
    • Route
    • Service
    • Outlying files
  • Voice

    • Encryption
    • Exception
    • Gateway
    • Handlers
    • IO
    • Streams
    • udp
    • Outlying files

@lukellmann
Copy link
Member

lukellmann commented Nov 21, 2022

I think for classes that only are 1:1 mappings of discord json models (like most things in dev.kord.common.entity) we shouldn't document every property but instead just link to discord's docs. That means we'll have less work keeping them up to date.

@NoComment1105
Copy link
Contributor Author

I think for classes that only are 1:1 mappings of discord json models (like most things in dev.kord.common.entity) we shouldn't document every property but instead just link to discord's docs. That means we'll have less work keeping them up to date.

Sounds good, I'll change my documenting style to that from now on

NoComment1105 and others added 11 commits November 24, 2022 15:18
# 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
@lukellmann lukellmann changed the base branch from 0.8.x to 0.9.x March 25, 2023 17:40
lukellmann and others added 2 commits April 6, 2023 14:27
# 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
@lukellmann lukellmann changed the base branch from 0.9.x to main June 17, 2023 13:50
@NoComment1105 NoComment1105 changed the title Lets get this show on the road Kdoc the Kord Jul 27, 2023
# 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
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Lots of places lack full documentation
2 participants