Some documentation on //todo-v5: docs #1838

oliver276 · 2021-09-21T18:08:16Z

I will take another look at all documentation here before I submit the PR for review. Sorry about the git history.

Not sure about the documentation on ChannelField, but other than the @see I'm not sure what else to do.

A commit that moved many constants to the MAX_NAME_LENGTH mistakenly also moved a few values that were 100 into a constant with value 25. This commit will add a new constant, MAX_NAME_OPTION_LENGTH, to fix those values back to their intended values of 100.

� Conflicts: � src/main/java/net/dv8tion/jda/api/interactions/commands/build/OptionData.java

…patch-1 � Conflicts: � src/main/java/net/dv8tion/jda/api/entities/BaseGuildMessageChannel.java � src/main/java/net/dv8tion/jda/api/entities/ChannelField.java � src/main/java/net/dv8tion/jda/api/entities/ICategorizableChannel.java

… at the top of the class

Codixer · 2021-12-02T21:38:29Z

@oliver276 / @DV8FromTheWorld
Any help needed on the documentation?

…patch-1

DV8FromTheWorld

Sorry it took so long. Loving the class-level documentation.

src/main/java/net/dv8tion/jda/api/entities/BaseGuildMessageChannel.java

src/main/java/net/dv8tion/jda/api/entities/ChannelField.java

src/main/java/net/dv8tion/jda/api/entities/IPositionableChannel.java

DV8FromTheWorld · 2021-12-24T05:48:26Z

src/main/java/net/dv8tion/jda/api/entities/TextChannel.java

- * <br>Adds additional functionality and information for text channels in Discord.
+ * Represents a standard Discord Text GuildChannel.
+ * <br>Adds additional functionality and information for text channels in Discord,
+ * on top of the common functionality present in other guild message channels.


As a note, the docs here and on NewsChannel are pretty wildly different. We might want to bring them in line with eachother.

src/main/java/net/dv8tion/jda/api/entities/ThreadChannel.java

src/main/java/net/dv8tion/jda/api/events/thread/ThreadHiddenEvent.java

DV8FromTheWorld · 2021-12-24T05:51:12Z

src/main/java/net/dv8tion/jda/api/events/thread/ThreadRevealedEvent.java

+ * For example, if the bot is given the {@link net.dv8tion.jda.api.Permission.ADMINISTRATOR} permission, any thread channels that the bot could not previously see would be "revealed".
+ *
+ * @see ThreadHiddenEvent
+ */


We need to double check and see if these events only fire if you were already in the channel or not. We need to document whether you need to be in the channel already or not to receive these events.

src/main/java/net/dv8tion/jda/api/entities/IThreadContainer.java

src/main/java/net/dv8tion/jda/api/managers/channel/concrete/ThreadChannelManager.java

…patch-1 � Conflicts: � src/main/java/net/dv8tion/jda/api/entities/ThreadChannel.java

src/main/java/net/dv8tion/jda/api/entities/ChannelField.java

DV8FromTheWorld · 2022-01-16T20:53:53Z

src/main/java/net/dv8tion/jda/api/entities/ICategorizableChannel.java

+    /**
+     * Get the snowflake of the {@link Category} that contains this channel.
+     *
+     * @return The Discord ID snowflake of the parent channel as a String.
+     */
    default String getParentCategoryId()
    {
        return Long.toUnsignedString(getParentCategoryIdLong());


This actually should be nullable. We need to add the annotation and update the code to check for an idLong of 0 to return null instead.

Can be separate PR as long as we actually do it.

src/main/java/net/dv8tion/jda/api/entities/ICategorizableChannel.java

src/main/java/net/dv8tion/jda/api/entities/ThreadChannel.java

src/main/java/net/dv8tion/jda/api/managers/channel/concrete/ThreadChannelManager.java

…patch-1

DV8FromTheWorld · 2022-01-19T21:22:27Z

src/main/java/net/dv8tion/jda/api/entities/ICategorizableChannel.java

     * @return The Discord ID snowflake of the parent channel as a long.
     */
    long getParentCategoryIdLong();

    /**
     * Get the snowflake of the {@link Category} that contains this channel.
     *
+     * This will return {@code 0} if this channel doesn't have a parent category.


This is not true as of #1993 which will probably cause some conflicts for you anyways.

DV8FromTheWorld

Almost done.

src/main/java/net/dv8tion/jda/api/entities/ThreadChannel.java

…patch-1 � Conflicts: � src/main/java/net/dv8tion/jda/api/entities/ICategorizableChannel.java

oliver276 and others added 7 commits September 2, 2021 12:33

Renames constant MAX_NAME_OPTION_LENGTH -> MAX_CHOICE_NAME_LENGTH

0b299e1

Fixes docs to correctly reference the Choice names.

cb33bd8

Update docs for affected methods

1ddbadc

Merge branch 'v5' of https://github.com/DV8FromTheWorld/JDA into patch-1

eefbb27

� Conflicts: � src/main/java/net/dv8tion/jda/api/interactions/commands/build/OptionData.java

Write up some more documentation

47b1bb6

Add some extra information about crossposting

1a2bbb1

MinnDevelopment added the type: documentation label Sep 22, 2021

oliver276 added 2 commits September 29, 2021 02:45

Merge branch 'v5' of https://github.com/DV8FromTheWorld/JDA into patch-1

0d8fc3f

Update bitrate docs

509a2be

DV8FromTheWorld added the v5 defines that something is slated for inclusion in v5 label Nov 7, 2021

DV8FromTheWorld deleted the branch discord-jda:master November 30, 2021 00:07

DV8FromTheWorld closed this Nov 30, 2021

DV8FromTheWorld reopened this Nov 30, 2021

DV8FromTheWorld changed the base branch from v5 to master November 30, 2021 00:20

oliver276 added 3 commits November 30, 2021 01:47

Adds extra TODOs where documentation is missing

64cbe9f

Adds more documentation of new keys, also formats so all generic keys…

90eafcf

… at the top of the class

oliver276 added 2 commits December 10, 2021 03:00

Documented the ThreadHiddenEvent and ThreadRevealedEvent

3a2bb03

Merge branch 'master' of https://github.com/DV8FromTheWorld/JDA into …

8e332b5

…patch-1

DV8FromTheWorld reviewed Dec 24, 2021

View reviewed changes

oliver276 added 2 commits December 24, 2021 07:22

Fixes from PR review.

c1499ab

some more work. I should commit and push more often

7183868

DV8FromTheWorld requested changes Jan 10, 2022

View reviewed changes

oliver276 added 2 commits January 11, 2022 09:33

Nearly done

07c5372

Merge branch 'master' of https://github.com/DV8FromTheWorld/JDA into …

8b858f8

…patch-1 � Conflicts: � src/main/java/net/dv8tion/jda/api/entities/ThreadChannel.java

DV8FromTheWorld requested changes Jan 16, 2022

View reviewed changes

oliver276 added 2 commits January 16, 2022 22:07

Document additional error responses

a1ce2aa

Merge branch 'master' of https://github.com/DV8FromTheWorld/JDA into …

bf9ab38

…patch-1

Apply changes from code review

8e906e8

oliver276 marked this pull request as ready for review January 16, 2022 22:57

Add more information to ThreadMember caching behaviour

a8f9005

Sanduhr32 mentioned this pull request Jan 18, 2022

Nullable parent string ID nullable for categorizable channels #1993

Merged

6 tasks

DV8FromTheWorld reviewed Jan 19, 2022

View reviewed changes

oliver276 added 2 commits January 19, 2022 21:40

Merge branch 'master' of https://github.com/DV8FromTheWorld/JDA into …

5375d1a

…patch-1 � Conflicts: � src/main/java/net/dv8tion/jda/api/entities/ICategorizableChannel.java

Apply fixes from code review

6cf61ed

DV8FromTheWorld approved these changes Jan 19, 2022

View reviewed changes

DV8FromTheWorld merged commit e4a2c5b into discord-jda:master Jan 19, 2022

renovate bot mentioned this pull request Mar 5, 2022

chore(deps): update dependency net.dv8tion:jda to v5.0.0-alpha.9 - autoclosed JourneyHQ/Library.kt#5

Closed

1 task

renovate bot mentioned this pull request Mar 13, 2022

Update dependency net.dv8tion:JDA to v5.0.0-alpha.9 rainbowdashlabs/cjda-util#10

Closed

1 task

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Some documentation on //todo-v5: docs #1838

Some documentation on //todo-v5: docs #1838

oliver276 commented Sep 21, 2021

Codixer commented Dec 2, 2021

DV8FromTheWorld left a comment

DV8FromTheWorld Dec 24, 2021

DV8FromTheWorld Dec 24, 2021

DV8FromTheWorld Jan 16, 2022

DV8FromTheWorld Jan 19, 2022

DV8FromTheWorld Jan 19, 2022

DV8FromTheWorld left a comment

Some documentation on //todo-v5: docs #1838

Some documentation on //todo-v5: docs #1838

Conversation

oliver276 commented Sep 21, 2021

Codixer commented Dec 2, 2021

DV8FromTheWorld left a comment

Choose a reason for hiding this comment

DV8FromTheWorld Dec 24, 2021

Choose a reason for hiding this comment

DV8FromTheWorld Dec 24, 2021

Choose a reason for hiding this comment

DV8FromTheWorld Jan 16, 2022

Choose a reason for hiding this comment

DV8FromTheWorld Jan 19, 2022

Choose a reason for hiding this comment

DV8FromTheWorld Jan 19, 2022

Choose a reason for hiding this comment

DV8FromTheWorld left a comment

Choose a reason for hiding this comment