Kdoc the Kord #729

NoComment1105 · 2022-11-21T00:24:18Z

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

lukellmann · 2022-11-21T12:32:01Z

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 · 2022-11-21T16:00:50Z

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

core/src/main/kotlin/event/channel/ChannelPinsUpdateEvent.kt

core/src/main/kotlin/event/channel/ChannelUpdateEvent.kt

core/src/main/kotlin/event/channel/thread/ThreadListSyncEvent.kt

# 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

…ckage

# 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

…ing now" This reverts commit bf3f1ff.

Galarzaa90 · 2024-08-13T23:10:04Z

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 · 2024-08-14T04:27:48Z

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 · 2024-08-14T04:32:05Z

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 · 2024-08-14T04:33:38Z

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 :)

# Conflicts: # core/src/commonMain/kotlin/entity/Icon.kt # core/src/commonMain/kotlin/entity/Member.kt # core/src/commonMain/kotlin/entity/User.kt # core/src/commonMain/kotlin/event/channel/thread/ThreadListSyncEvent.kt # core/src/commonMain/kotlin/event/interaction/ApplicationCommandCreate.kt # core/src/commonMain/kotlin/event/interaction/ApplicationCommandDelete.kt # core/src/commonMain/kotlin/event/interaction/ApplicationCommandUpdate.kt # core/src/commonMain/kotlin/event/message/ReactionAddEvent.kt

Galarzaa90

Some small typos and suggestions.

Galarzaa90 · 2024-08-14T13:08:43Z

core/src/commonMain/kotlin/Kord.kt

@@ -99,9 +102,15 @@ public class Kord(

    override val coroutineContext: CoroutineContext = SupervisorJob() + dispatcher

+    /**
+     * Returns a [Flow] of [Region]s know to the bot.


know -> known

Line 112 too

Galarzaa90 · 2024-08-14T13:14:26Z

core/src/commonMain/kotlin/Unsafe.kt

    public fun autoModerationRule(guildId: Snowflake, ruleId: Snowflake): AutoModerationRuleBehavior =
        AutoModerationRuleBehaviorImpl(guildId, ruleId, kord)

+    /**
+     * Returns an [KeywordAutoModerationRuleBehavior] for a given [guildId].


article: an -> a

Galarzaa90 · 2024-08-14T13:21:11Z

core/src/commonMain/kotlin/entity/Invite.kt

@@ -140,6 +142,9 @@ public open class Invite(
 /**
 * An instance of a [Discord Invite](https://discord.com/developers/docs/resources/invite) with
 * [extra information](https://discord.com/developers/docs/resources/invite#invite-metadata-object).
+ *
+ * @param kord The Kord instance that created this object
+ * @param supplier THe supplier used to request entities


Galarzaa90 · 2024-08-14T13:27:22Z

core/src/commonMain/kotlin/entity/Presence.kt

@@ -11,20 +11,30 @@ import dev.kord.core.exception.EntityNotFoundException
 import dev.kord.core.supplier.EntitySupplier
 import dev.kord.core.supplier.EntitySupplyStrategy

+/**
+ * Represents a user's current state on a guild.


I think "current status" would be more appropiate.

Galarzaa90 · 2024-08-14T13:30:44Z

core/src/commonMain/kotlin/event/gateway/Events.kt

@@ -15,8 +15,14 @@ import dev.kord.gateway.GatewayCloseCode
 import kotlinx.coroutines.flow.Flow
 import kotlinx.coroutines.flow.filter

+/**
+ * A Gateway recieved an event.


recieved -> received

Galarzaa90 · 2024-08-14T13:33:18Z

core/src/commonMain/kotlin/event/guild/GuildCreateEvent.kt

+ * 2. When a Guild becomes available again to the client
+ * 3. When the current user joins a new Guild.
+ *
+ *  _Scenarios 1 and 3 may be marked unavailable during an outage_


While this is true, kord does not support this unavailable flag in this event, so that should be noted here until it is implemented.

Galarzaa90 · 2024-08-14T13:34:30Z

core/src/commonMain/kotlin/event/guild/InviteCreateEvent.kt

@@ -131,37 +133,37 @@ public class InviteCreateEvent(
     * Requests to get the [Channel] this invite is for.
     *
     * @throws [RequestException] if anything went wrong during the request.
-     * @throws [EntityNotFoundException] if the  wasn't present.
+     * @throws [EntityNotFoundException] if the wasn't present.


missing word here: if the channel wasn't present.

Galarzaa90 · 2024-08-14T13:38:28Z

core/src/commonMain/kotlin/event/interaction/ApplicationCommandUpdate.kt

@@ -4,6 +4,13 @@ import dev.kord.core.Kord
 import dev.kord.core.entity.application.*
 import dev.kord.core.event.Event

+/**
+ * The event dispatched when an [GuildApplicationCommand] is updated.


article: an -> a

Galarzaa90 · 2024-08-14T14:08:10Z

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

NoComment1105 and others added 2 commits November 21, 2022 00:14

Lets get this show on the road

3c75c23

Merge branch 'kordlib:0.8.x' into docs-docs-docs

cd1df72

More doc progress

d73ff4c

lukellmann reviewed Nov 21, 2022

View reviewed changes

core/src/main/kotlin/event/channel/ChannelPinsUpdateEvent.kt Outdated Show resolved Hide resolved

lukellmann reviewed Nov 21, 2022

View reviewed changes

core/src/main/kotlin/event/channel/ChannelUpdateEvent.kt Outdated Show resolved Hide resolved

core/src/main/kotlin/event/channel/thread/ThreadListSyncEvent.kt Outdated Show resolved Hide resolved

NoComment1105 and others added 11 commits November 24, 2022 15:18

Documents Documents Documents

5c2bac4

More Docs yey

e85b597

Merge branch 'kordlib:0.8.x' into docs-docs-docs

197690e

I'm going to run out of commit names

c6a506b

Add docs to new nulllable guild functions

5db1987

Document remaining events

083719c

Document the outlying files for the core package

943b33b

Document the exception, supplier and builder packages for the core pa…

7eb9042

…ckage

Document live and gateway pacakge

b270f22

Work on entity packages

89a6c4e

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

More docs for core entites

fd92e97

lukellmann force-pushed the 0.9.x branch from 72481d0 to 5b3a7ef Compare April 24, 2023 18:12

lukellmann changed the base branch from 0.9.x to main June 17, 2023 13:50

NoComment1105 changed the title ~~Lets get this show on the road~~ Kdoc the Kord Jul 27, 2023

NoComment1105 added 4 commits August 2, 2023 10:31

Change joined_at field to optional due to guest invites existing now

bf3f1ff

Revert "Change joined_at field to optional due to guest invites exist…

c670a50

…ing now" This reverts commit bf3f1ff.

I did it wrong lol, just null it

9c66705

Merge branch 'kordlib:main' into main

138ab3f

NoComment1105 added 2 commits August 14, 2024 05:40

Remove file that no longer exists in the main branch

dc848e0

NoComment1105 mentioned this pull request Aug 14, 2024

Add KDocs to the kord/core package #967

Draft

NoComment1105 closed this Aug 14, 2024

NoComment1105 deleted the docs-docs-docs branch August 14, 2024 04:51

Galarzaa90 reviewed Aug 14, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Kdoc the Kord #729

Kdoc the Kord #729

NoComment1105 commented Nov 21, 2022 •

edited

Loading

lukellmann commented Nov 21, 2022 •

edited

Loading

NoComment1105 commented Nov 21, 2022

Galarzaa90 commented Aug 13, 2024

NoComment1105 commented Aug 14, 2024

Galarzaa90 commented Aug 14, 2024

NoComment1105 commented Aug 14, 2024

Galarzaa90 left a comment

Galarzaa90 Aug 14, 2024

Galarzaa90 Aug 14, 2024

Galarzaa90 Aug 14, 2024

Galarzaa90 Aug 14, 2024

Galarzaa90 Aug 14, 2024

Galarzaa90 Aug 14, 2024

Galarzaa90 Aug 14, 2024

Galarzaa90 Aug 14, 2024

Galarzaa90 commented Aug 14, 2024

Kdoc the Kord #729

Kdoc the Kord #729

Conversation

NoComment1105 commented Nov 21, 2022 • edited Loading

lukellmann commented Nov 21, 2022 • edited Loading

NoComment1105 commented Nov 21, 2022

Galarzaa90 commented Aug 13, 2024

NoComment1105 commented Aug 14, 2024

Galarzaa90 commented Aug 14, 2024

NoComment1105 commented Aug 14, 2024

Galarzaa90 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Galarzaa90 commented Aug 14, 2024

NoComment1105 commented Nov 21, 2022 •

edited

Loading

lukellmann commented Nov 21, 2022 •

edited

Loading