FreeRDP/FreeRDP — pull request #463 by littlejawa (2012-02-27 09:23:09+00:00)
Title: Adding comments in the code to improve doxygen-generated doc

Hi,

I am new to the project, and I want to contribute as possible. I started to read and learn the sources for FreeRDP, and found there was not much documentation on the API and structures. Since learning is mandatory before contributing, I thought I may help by improving the documentation: it can lower the learning curve for new contributors, and improve maintainability as existing contributors may forget the code they wrote long ago.
I didn't know where to start, so I just took the xfreerdp "main()" function, and started reading. My first pull request contains most comments for xreerdp.c, and some into the libfreerdp-core, as it was called from there. I plan on digging deeper in the core lib, and continue adding comments on my way.
Most comments are written from scratch, but I also slightly modified existing ones for doxygen's interpretation. The goal is to have both readable code and useful documentation - don't hesitate to tell me if / where I miss it, I can only improve :-)

Regards,
Little Jawa