Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve API documentation #80

Open
ArcadeArchie opened this issue Aug 24, 2023 · 2 comments
Open

Improve API documentation #80

ArcadeArchie opened this issue Aug 24, 2023 · 2 comments

Comments

@ArcadeArchie
Copy link

ArcadeArchie commented Aug 24, 2023

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

@nikeee
Copy link
Owner

nikeee commented Aug 25, 2023

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

@ArcadeArchie
Copy link
Author

Will do when i find the time

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants