JJL772
commented
4 years ago Doxygen seems to generate way too much documentation for even tier0 alone. It's in the 100's of megabytes. :( An alternative to doxygen is a custom script that can rip out structs, enums, classes and functions and throw them into markdown docs with comments attached. We can then slowly edit the markdown docs to elaborate on the documentation. For the most part, reading the code is enough to understand what something does, but for more obscure things, manual documentation is a better idea. The only issue with this idea is that we can't use CI to automatically generate the docs (since we would be editing the output), so we should just write "documentation" by attaching comments to structs/enums/classes/function in the headers themselves, and then using thee aforementioned script to throw them into markdown files.
Autogenerated documentation for low-level libs (such as tier0, tier1, etc.) would be very beneficial. Docs should probably be generated every day or two.