API

Why can't I find all the documentation in this wiki?

Most of the documentation of functions in guthscpbase are only present in the source code for two reasons:

  1. As there is no documentation generator for the code documentation convention I use, it is less work to only maintain one side.

  2. It allows you ─ as a (probably) future module developper, to fully understand the limitations and usage of the code behind these functions since you can directly read the source code at the same time that reading its documentation.

TLDR: usual developper laziness

Despite these reasons, I will try to write documentation in this wiki for important classes and systems as well as for tutorials. Unfortunately, this take time so if you find yourself having questions that this wiki can't answer, I encourage you to read the code or to contact me via a Github issue or Discord.

Source Code

Here you can find a short summary of each file purpose:

Last updated