search

TheLuaOSProject / Kernel

Kernel for the LuaOS operating system
GNU General Public License v3.0
36 stars 4 forks source link

Starting documentation #33

Closed BeeverFeever closed 7 months ago

BeeverFeever commented 1 year ago

Started documenting the use, parameters and return values of functions as comments in header files. All of the comments need review as I'm not confident in a lot of the info, I will continue to work on them and correct any errors I have made.

Also I didn't really think very well and there is the shift key commits in this pr as well, they just allow both shift keys to work when getting input from the kernel.

Frityet commented 1 year ago

Please use Doxygen for comments

BeeverFeever commented 1 year ago

I've been through all of the files and I have documented almost all things I understand, there is still some things like typedefs and structs that I can document and will do later on. I will still work on docs I just have a couple things that I want to give a go at implementing. If there is any major issues tell me and I will fix them, if not then you can merge this if you are happy.

Frityet commented 1 year ago

I've been through all of the files and I have documented almost all things I understand, there is still some things like typedefs and structs that I can document and will do later on. I will still work on docs I just have a couple things that I want to give a go at implementing. If there is any major issues tell me and I will fix them, if not then you can merge this if you are happy.

Ill start working on this PR then, to try and fill in some holes. Thank you so much!