Documentation #7
Comments
Semaphores aren't based on the CoreCLR anymore; that was left over from when I was screwing about trying to get things to work. Now we can decode JSON using the static methods of entity<T> classes, and in the future typechecking will be put in to ensure valid json is passed to these types (right now it will throw a json exception, we should add custom exception types to make errors easier to debug. TODO from this point onwards: - Implement REST API methods in api_client.cpp (see #5) - Remove `disccord_` prefix from client types - Add entity types for all discord entities - Implement websocket API (see #6) - Implement entity cache - Clean up includes - Include a test script (?) - Expand test range (see #2) - Write documentation (see #7 for more info)
|
doxygen, maybe? IMO, should just contain class references to everything. and maybe a few examples to get people used to working with the doc. |
|
You can find a good Beginner's Guide here: http://www.writethedocs.org/guide/writing/beginners-guide-to-docs/ About the tools, Github Pages itself manage to render pages in HTML from Markdown using the Jekyll engine. It's an option for your repository to turn on. |
|
The problem with Jekyll is that it means we have to separate the docs and code - it isn't really useful to people who have IDEs which can display documentation while working on code using disccord. I think doxygen would probably be the smartest route, and we could probably use GitHub pages to host the docs (maybe add a build step to Travis to push back doxygen stuff after a successful build?) |
What tools should we use for generating documentation? What should the docs contain?
The text was updated successfully, but these errors were encountered: