search

TokTok / website

The TokTok website
https://toktok.ltd/
GNU General Public License v3.0
10 stars 54 forks source link

API docs for ToxCore and related libraries #99

Open SkyzohKey opened 6 years ago

SkyzohKey commented 6 years ago

This change is Reviewable

iphydf commented 6 years ago

Would it make sense to host these docs on the website instead? I.e. making their generation part of the website build process?

sudden6 commented 6 years ago

I think docs on the website would be very cool, if possible with a selectable version like for cmake: https://cmake.org/cmake/help/v3.3/command/install.html

SkyzohKey commented 6 years ago

Summoning @naxuroqa here as I guess he updated the VAPI interface and so he can gives you more up to date docs :)

naxuroqa commented 6 years ago

The docs for the vala bindings used by venom are at https://naxuroqa.github.io/vala-toxcore-c/ They can be auto generated from the vapi files. I adapted most comments to be usable for valadoc. As far as I can test them with travis they all work. The vapi files themself are at https://github.com/naxuroqa/vala-toxcore-c

naxuroqa commented 6 years ago

The question would be what kind of documentation you want. While the vala documentation might be useful for some, I guess something like a doxygen generated doc would be better for anyone using the c-api.

I'm all for docs on the website either way, if possible even with (small) usage examples. (Similar to this)

iphydf commented 6 years ago

@naxuroqa I'd be happy linking to externally hosted API docs from the integrations page. I was hoping to have some API docs built from tox.h, but not using doxygen (too much overhead). A simple html page that fits into our template would be nice.