TeamSpeak3QueryApi icon indicating copy to clipboard operation
TeamSpeak3QueryApi copied to clipboard

Improve API documentation

Open ArcadeArchie opened this issue 1 year ago • 2 comments

Im currently making a bot that interfaces with Twitch and TS(i.e. kick somebody as a channelpoint reward).

and its very difficult to figure out what works in which way without digging through the source code or the manual, for example:

  • using ClientMoved requires RegisterChannelNotification() or that if you want to listen for events from all channels that you need to call RegisterChannelNotification(0) which isnt documented in the API or manual from TeamSpeak
  • Most DTOs/Entites and their properties have little to none documentation, like ClientId vs DatabaseID (which isnt documented well by TeamSpeak itself but thats besides the point)

i know this is a work in progress library, but still some rudimentary documentation even if its just XML docs in C# would be appreciated

Thank you in advance for the response

ArcadeArchie avatar Aug 24 '23 23:08 ArcadeArchie

I don't have the time to do this myself. This project is open for contributions. I'd take a PR for that. :)

nikeee avatar Aug 25 '23 03:08 nikeee

Will do when i find the time

ArcadeArchie avatar Aug 25 '23 10:08 ArcadeArchie