Skip to content

Improve documentation #575

@StoneLabs

Description

@StoneLabs

First up: Awesome library! Good job.
However, It can sometimes be a bit frustrating to dig through the source to find out how some things work.
It would really elevate the library if there were more xml docs.

Some examples that came to mind:

E.g. ConnectionRequest.Reject() vs. .RejectForce()
What exactly is the difference, I assume RejectForce doesn't send a rejection packet? But i can't be sure until i dig my way through the source.

E.g. Manuel mode
How exactly does it work? Gotta go to the source and figure it out

E.g. NetPeer.Disconnect
Does it send a disconnect packet or just drops the other end? Or maybe its dependent on whether or not there is a byte[] supplied? Also, will packets sent right before be sent at the next Poll or are they dropped?

Etc. you get the idea.
Anyways, again thanks for the awesome work!

Metadata

Metadata

Assignees

No one assigned

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions