Skip to content

XML Documentation Updates and ImageUrl Changes. - #21

Merged
KubaZ2 merged 30 commits into
NetCordDev:alphafrom
Red-K0:alpha
Jul 10, 2024
Merged

XML Documentation Updates and ImageUrl Changes.#21
KubaZ2 merged 30 commits into
NetCordDev:alphafrom
Red-K0:alpha

Conversation

@Red-K0

@Red-K0 Red-K0 commented May 18, 2024

Copy link
Copy Markdown
Contributor

No description provided.

@Red-K0

Red-K0 commented May 18, 2024

Copy link
Copy Markdown
Contributor Author

More changes to be added later, this is a placeholder.

Red-K0 added 3 commits May 18, 2024 22:13
GatewayClient and GatewayIntents modified to use `<remarks>` tags, as well as replacing unintentional tabs with spaces.
@Red-K0 Red-K0 changed the title Changed the description of GatewayClient to be more in line with .NET XML Documentation Updates May 21, 2024
@Red-K0

Red-K0 commented May 21, 2024

Copy link
Copy Markdown
Contributor Author

Note, documentation above is not final or complete.

Red-K0 added 2 commits May 22, 2024 02:41
- Added additional undocumented flags for ApplicationFlags.cs, as well as GuildUserFlags.cs
- Added extra documentation to UserFlags
Documented all non-SG methods and objects related to users. The following files are affected:
- GuildUser.cs
- PartialGuildUser.cs
- PartialGuildUserExtensions.cs
- GuildUserInfo.cs
- GuildUserJoinSourceType.cs
- User.cs
@Red-K0

Red-K0 commented May 21, 2024

Copy link
Copy Markdown
Contributor Author

In terms of documentation coverage for user and user-adjacent code, I believe it is just User.TryFormat() and Source Generator members that are left.

@Red-K0 Red-K0 changed the title XML Documentation Updates XML Documentation Updates and ImageUrl Changes. May 23, 2024
@Red-K0

Red-K0 commented May 23, 2024

Copy link
Copy Markdown
Contributor Author

Current list of documented files in this PR.

  • User.cs
  • GuildUser.cs
  • RestMessage.cs
  • Message.cs
  • IPartialMessage.cs
  • RestGuild.cs
  • Guild.cs
  • Various flags

@Red-K0 Red-K0 left a comment

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Reviewed the documentation.

Comment thread NetCord/Gateway/Guild.cs Outdated
Comment thread NetCord/GuildUser.cs
Comment thread NetCord/GuildUserFlags.cs Outdated
Comment thread NetCord/GuildUserFlags.cs Outdated
Comment thread NetCord/MessageType.cs Outdated
Comment thread NetCord/User.cs Outdated
Comment thread NetCord/User.cs Outdated
Comment thread NetCord/Gateway/Guild.cs
Comment thread NetCord/Gateway/Guild.cs
Comment thread NetCord/Gateway/Guild.cs
Comment thread NetCord/Rest/RestGuild.cs
@KubaZ2
KubaZ2 self-requested a review July 10, 2024 19:38
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.

2 participants