Skip to content

docs: Added missing XML documentation#2034

Closed
TwoTenPvP wants to merge 3 commits intodevelopfrom
albin-xml-doc
Closed

docs: Added missing XML documentation#2034
TwoTenPvP wants to merge 3 commits intodevelopfrom
albin-xml-doc

Conversation

@TwoTenPvP
Copy link
Copy Markdown
Contributor

No description provided.

@TwoTenPvP TwoTenPvP requested review from a team as code owners June 23, 2022 14:28
private NetworkPipeline m_ReliableSequencedPipeline;

/// <summary>
/// The client id used to represent the server.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Might want to add a note that this uses the "transport ID" of the client. It doesn't match the client IDs that users are normally handling.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

On second thought maybe it's not worth mentioning it. Every client ID handled in this file is a "transport ID". Making a note only here could lead someone to think other uses of client IDs are not "transport IDs".

}

/// <summary>
/// Send a payload to the specified clientId, data and channelName.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Channel name is inaccurate. Only delivery types are used now.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

^

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.

True, but this was copied from the underlying Transport.cs, so that's probably where the fix should be made primarly.

Copy link
Copy Markdown
Contributor Author

@TwoTenPvP TwoTenPvP Jun 25, 2022

Choose a reason for hiding this comment

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

This is because the inheritdoc tag that is super useful is not supported basically anywhere. So copy paste has to be done.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

so, fix them in both places?

@TwoTenPvP
Copy link
Copy Markdown
Contributor Author

Closed and continued in #2026

@TwoTenPvP TwoTenPvP closed this Jun 27, 2022
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.

3 participants