Documentation for public API

Surreal-Net / Surreal.Net

Database driver for SurrealDB available for REST and RPC sessions.

Apache License 2.0

57 stars 7 forks source link

Documentation for public API #90

Open ProphetLamb opened 2 years ago

ProphetLamb commented 2 years ago

When compiling to release mode, missing XML-documentation warnings are emitted. The generated XML-documentation is used to generate the API-documentation. It is therefore essential to have good documentation coverage. (I am personally very bad at it ^^)

jeffugo commented 2 years ago

Hi @ProphetLamb. I'd like to give this a go.

ProphetLamb commented 2 years ago

@jeffugo Awesome! Let me know if you need any assistance. Keep in mind, that these warnings are only generated for a release build dotnet build -c:Release. Have fun!

jeffugo commented 2 years ago

Hi @ProphetLamb. Unfortunately, I won't be able to work on this. I took on another project when I didn't get a reply after a few days.