2008-05-11, 23:56
I'm actually taking a look to the XMBC source code and as I can see even if there are some comments they are not very useful in order to understand the wide operation for a beginner like me .
I think I'm not the one who would like to code for XBMC so why not to start a campaign of commenting the source code?
- What we can find in the file (for example, XboxMediaCenter.cpp is the main entry of XBMC)
- Functions description (what they do and what they return)
- Variable purpose
- etc...
This will be very useful to document the code and if we follow the doxygen syntax we will have some prety html files to put on the website
I think I'm not the one who would like to code for XBMC so why not to start a campaign of commenting the source code?
- What we can find in the file (for example, XboxMediaCenter.cpp is the main entry of XBMC)
- Functions description (what they do and what they return)
- Variable purpose
- etc...
This will be very useful to document the code and if we follow the doxygen syntax we will have some prety html files to put on the website