KOS API Documentation

Place for discussing homebrew games, development, new releases and emulation.
User avatar
Falco Girgis
Developer
Posts: 110

KOS API Documentation

Post by Falco Girgis »

Just wanted to give you guys a heads up that the documentation for KallistiOS has been completely redone and should now actually be useful to people wishing to browse for information by API:
https://kos-docs.dreamcast.wiki/topics.html

Oh, also these docs should be auto-generated every morning based on the latest code in the master branch.

Our docs have been something I have wanted to improve on since day 1 of joining the KOS team. We've done a decent job at adding good descriptions for all of the actual functions, but our organization of content was very poor and lacked higher-level descriptions. This took 4 straight days of my Christmas break to do, since I had to go through every header file in KOS, but I'm happy with the results. This is my Christmas present to the scene! :lol:

Anyway, going through, you might notice some topics have far more information and examples than others... Now that the top-level organization is complete, we will be slowly working to fill everything in with more detailed information like these:
Screenshot from 2024-01-04 22-33-39.png
Screenshot from 2024-01-04 22-34-07.png

  • Similar Topics
    Replies
    Views
    Last post