LiveSplit / SpeedrunComSharp

A .NET Library that can be used to interact with the Speedrun.com API
MIT License
32 stars 9 forks source link

Add XML documentation #24

Closed Suprnova closed 2 years ago

Suprnova commented 2 years ago

This PR adds documentation to most methods accessed by library users, as well as several structs and enums, specifically Ordering and Embedding, via C# XML documentation comments. This allows developers to see an overview of the methods and objects they're using, as well as the descriptions for the parameters being provided. This information is displayed automatically through the IDE, primarily through IntelliSense, as seen below. image