Page 2 of 2

Re: Update/add to documentation for controls

Posted: Wed May 07, 2025 5:41 am
by hiran
readyready15728 wrote: Tue Apr 29, 2025 11:22 pm
Took me a little to remember that I can view my current contracts by pressing F5 twice. That (and the primary function of F5) isn't mentioned here:

https://wiki.alioth.net/index.php/Oolit ... d_Controls

There is a reference sheet on GitHub which does mention this but it's stamped with "Outdated":

https://github.com/OoliteProject/oolite ... liteRS.pdf

I'd like to do more than complain at some point BTW. I don't know any Objective-C but I guess documentation could be a start.
I thought to have responded earlier but cannot find that post.

Starting on documentation is an excellent start. Now that the PDFs are fixed the wiki page could be improved. But rather than duplicating data from the PDF (which means two places to maintain) it could point users to the PDF and tell how to find it.

Further the core source code could use some documentation. We use doxygen and coverage reports. It looks like the code is close to not documented at all. In fact there are comments - but not marked that doxygen would pick them up. Changing them might be a light change and allow more people to get familiar on the codebase.

All contributors need to have accounts and privileges that the right people in this forum can grant.