alec1o / Netly

Cross-Platform and Multi-Protocol C# Socket Library. (Extremely fast and easy) 🇳 🇪 🇹 🇱 🇾
https://netly.docs.kezero.com
MIT License
58 stars 8 forks source link

include API documentation and Guide (v4). #32

Open alec1o opened 6 months ago

alec1o commented 6 months ago

Is your feature request related to a problem? Please describe.

the docs of project is manual and maybe can have errors on api. and is hard mantain manual wrote, for fix that should consider include tools to generate api from sources using XML comments.

Describe the solution you'd like

A clear and concise description of what you want to happen.

Describe alternatives you've considered

  1. Found tools to generate docs from XML comments.
      1. DocFx is most easy way to do this! (Most better choice)

Additional context

If the choice is DocFx

alec1o commented 5 months ago

C# API generation is working: 0fe42cea0e08e789b02bdc7725a73a254f43c8d4