Request: code comments

View previous topic View next topic Go down

Request: code comments

Post  jack77 on Mon Feb 23, 2009 11:03 pm

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.

jack77

Posts : 11
Join date : 2009-02-23

View user profile

Back to top Go down

Re: Request: code comments

Post  sio2interactive on Tue Feb 24, 2009 3:48 am

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...
avatar
sio2interactive

Posts : 1526
Join date : 2008-08-26
Age : 38
Location : Shanghai

View user profile http://sio2interactive.com

Back to top Go down

Re: Request: code comments

Post  uprise78 on Tue Feb 24, 2009 11:23 am

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

View user profile

Back to top Go down

Re: Request: code comments

Post  sio2interactive on Tue Feb 24, 2009 4:03 pm

totally! Im backing that at 110% Wink

Comment the stuff and send me back by email the file so I can include the commented version within the source tree...
avatar
sio2interactive

Posts : 1526
Join date : 2008-08-26
Age : 38
Location : Shanghai

View user profile http://sio2interactive.com

Back to top Go down

Re: Request: code comments

Post  Sponsored content


Sponsored content


Back to top Go down

View previous topic View next topic Back to top

- Similar topics

 
Permissions in this forum:
You cannot reply to topics in this forum