Kdoc the Kord

[NoComment1105]

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
  • [x] Builder
  • [ ] Cache
  • [ ] Entity
  • [x] Event
  • [x] Exception
  • [x] Gateway
  • [x] Live
  • [x] Supplier
  • [x] Outlying files

• [ ] Rest

  • [ ] Builder
  • [ ] JSON
  • [ ] Ratelimit
  • [ ] Request
  • [ ] Route
  • [ ] Service
  • [ ] Outlying files

• [ ] Voice

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

[lukellmann]

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]

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

[Galarzaa90]

I was recently thinking... there's many undocumented classes, specially ___Data classes. And I was thinking of doing this (altought probably in various smaller PRs).

And then I found this 😬

[NoComment1105]

I was recently thinking... there's many undocumented classes, specially ___Data classes. And I was thinking of doing this (altought probably in various smaller PRs).

And then I found this 😬

Yeah this PR is quite old now, I need to split it down into smaller ones to reduce the size of the PR required. Thanks for reminding me I can do this now :)

[Galarzaa90]

I was recently thinking... there's many undocumented classes, specially ___Data classes. And I was thinking of doing this (altought probably in various smaller PRs). And then I found this 😬

Yeah this PR is quite old now, I need to split it down into smaller ones to reduce the size of the PR required. Thanks for reminding me I can do this now :)

Yeah I was interested in doing this, but I think it would be better if I wait for this to be merged so I could check whatever was left missing (or added later). Glad I decided to do a search before starting 😅

[NoComment1105]

I was recently thinking... there's many undocumented classes, specially ___Data classes. And I was thinking of doing this (altought probably in various smaller PRs). And then I found this 😬

Yeah this PR is quite old now, I need to split it down into smaller ones to reduce the size of the PR required. Thanks for reminding me I can do this now :)

Yeah I was interested in doing this, but I think it would be better if I wait for this to be merged so I could check whatever was left missing (or added later). Glad I decided to do a search before starting 😅

Haha yeah, I'm currently bringing the PR up to date and will then make some smaller PRs to make it easier :)

[Galarzaa90]

Damn it, I thought I was looking at the new PR 😭