-
Notifications
You must be signed in to change notification settings - Fork 12
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
Added some miscellaneous missing xmldocs #8
Changes from 13 commits
8dc6f2e
6c3f85d
d64f670
677e715
14b645a
e8b3b49
c572a98
981e2eb
9fcea88
a46910c
3d8e082
9185853
9bbf580
c8bc452
1d20132
d9e1864
e41136c
25c208c
cee1522
6e80cef
3ad948d
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,17 +1,39 @@ | ||
using System; | ||
using System; | ||
|
||
namespace Discord | ||
{ | ||
public interface IGuildIntegration | ||
{ | ||
/// <summary> Gets the integration ID. </summary> | ||
/// <returns> Gets the integration ID. </returns> | ||
ulong Id { get; } | ||
/// <summary> Gets the integration name. </summary> | ||
/// <returns> Gets the integration name. </returns> | ||
string Name { get; } | ||
/// <summary> Gets the integration type (twitch, youtube, etc). </summary> | ||
/// <returns> Gets the integration type (twitch, youtube, etc). </returns> | ||
string Type { get; } | ||
/// <summary> Gets if this integration is enabled or not. </summary> | ||
/// <summary> Gets if this integration is enabled or not. </returns> | ||
bool IsEnabled { get; } | ||
/// <summary> Gets if this integration is syncing or not. </summary> | ||
/// <returns> Gets if this integration is syncing or not. </returns> | ||
bool IsSyncing { get; } | ||
/// <summary> Gets the ID that this integration uses for "subscribers". </summary> | ||
/// <returns> Gets the ID that this integration uses for "subscribers". </returns> | ||
ulong ExpireBehavior { get; } | ||
/// <summary> Gets the grace period before expiring subscribers. </summary> | ||
/// <returns> Gets the grace period before expiring subscribers. </returns> | ||
ulong ExpireGracePeriod { get; } | ||
/// <summary> Gets when this integration was last synced. </summary> | ||
/// <returns> Gets when this integration was last synced. </returns> | ||
DateTimeOffset SyncedAt { get; } | ||
/// <summary> | ||
/// Gets integration account information. See <see cref="IntegrationAccount"/>. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
|
||
/// </summary> | ||
/// <returns> | ||
/// Gets integration account information. See <see cref="IntegrationAccount"/>. | ||
/// </returns> | ||
IntegrationAccount Account { get; } | ||
|
||
IGuild Guild { get; } | ||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,14 +1,23 @@ | ||
using System.Collections.Generic; | ||
using System.Collections.Generic; | ||
|
||
namespace Discord | ||
{ | ||
public interface IConnection | ||
{ | ||
/// <summary> Gets the ID of the connection account. </summary> | ||
/// <returns> Gets the ID of the connection account. </returns> | ||
string Id { get; } | ||
/// <summary> Gets the service of the connection (twitch, youtube). </summary> | ||
/// <returns> Gets the service of the connection (twitch, youtube). </returns> | ||
string Type { get; } | ||
/// <summary> Gets the username of the connection account. </summary> | ||
/// <returns> Gets the username of the connection account. </returns> | ||
string Name { get; } | ||
/// <summary> Gets whether the connection is revoked. </summary> | ||
/// <returns> Gets whether the connection is revoked. </returns> | ||
bool IsRevoked { get; } | ||
|
||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Keep the line-break as is. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Oops, bad habit of mine. |
||
/// <summary> Gets a <see cref="IReadOnlyCollection{T}"/> of integration IDs. </summary> | ||
/// <returns> Gets a <see cref="IReadOnlyCollection{T}"/> of integration IDs. </returns> | ||
IReadOnlyCollection<ulong> IntegrationIds { get; } | ||
} | ||
} |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pardon, but you might have misunderstood what I meant by the last request.
summary
andreturns
should not state the same thing.summary
summarizes the member's purpose and what it does.returns
explains what object is being returned and what for.For example:
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for the clarification and the example.