Request: code comments
3 posters
Request: code comments
Going thru the code for the first time.
All the files in trunk/src are comment-free (except if the licence text counts). I have no clue what the functions do. It looks like the Linux kernel source code :-O
Documenting at least the purpose of an API function, and its return values, seems like the commonly accepted bare minimum.
All the files in trunk/src are comment-free (except if the licence text counts). I have no clue what the functions do. It looks like the Linux kernel source code :-O
Documenting at least the purpose of an API function, and its return values, seems like the commonly accepted bare minimum.
jack77- Posts : 11
Join date : 2009-02-23
Re: Request: code comments
I would more than happy to find the time to do that... but unfortunately I don't sorry... you are welcome to start doing it... I can provide support by email...
Re: Request: code comments
This should definitely be something everyone has a hand if. If you dive into the source and figure out what something does, just stick a comment in there. If everyone using SIO2 helps out and comments anything they come across this will be done in no time.
uprise78- Posts : 228
Join date : 2008-10-31
Re: Request: code comments
totally! Im backing that at 110%
Comment the stuff and send me back by email the file so I can include the commented version within the source tree...
Comment the stuff and send me back by email the file so I can include the commented version within the source tree...
Similar topics
» Code Response(s) on features & Request(s)
» [Request] IPO callback, animation done trigger
» REQUEST: Lua to Python
» tutorial request
» Request: function to fade between render callbacks
» [Request] IPO callback, animation done trigger
» REQUEST: Lua to Python
» tutorial request
» Request: function to fade between render callbacks
Permissions in this forum:
You cannot reply to topics in this forum
|
|