After my first look in the bygfoot C code, there is my first impression :
Very good !!
But (yes there is always one but...) the code documentation is not present.
For some school project, We're using doxygen tools -http://www.doxygen.org- (like javadoc tools):
It's generate Code documentation from tag found in .h (and .c file). There is one example :
- Code: Select all
* This is a dummy function
*@param dummy a dummy param
*@return Return Always 42
gint answerOfUltimateQuestion(int dummy);
The idea behing : improve the code legibility, we know what the function does and information about parameters, just reading the .h file and not read inside .c file.
More over doxygen generate good documentation in html.
I think this can help someone to send patch/contribution if he can read and understand only with .h and not go inside .c.
Some functions are documented but not in doxygen format so... .