Give some doxygen to the source code
#1
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 Rolleyes.

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 Wink
Reply
#2
Go for it. I'm happy to support you in any way I can.
Always read the XBMC online-manual, FAQ and search the forum before posting.
Do not e-mail XBMC-Team members directly asking for support. Read/follow the forum rules.
For troubleshooting and bug reporting please make sure you read this first.


Image
Reply
#3
You'll find that SOME code is commented for doxygen already, but the vast majority isn't Sad
Reply

Logout Mark Read Team Forum Stats Members Help
Give some doxygen to the source code1