[Freeswitch-dev] FreeSWITCH Documentation

Muhammad Shahzad shahzad at vopium.com
Fri Sep 18 00:18:42 PDT 2009


Hi,

I have observed that one of the major hurdle while writing patches and / or
bug fixes is lack of doxygen documentation for FS source code. For example
it took me 5+ days to understand mod_dingaling code and its hooks into FS
source code to write up soft reload patch, while it could have taken less
then 3 days to do so if source code documentation was available.

So, since right now i have some human resources including myself available,
I would like to document all source code (or at least core FS code i.e.
everything that has "switch_" prefix) using doxygen. I know its a huge task
and will take a while to complete but at least lets get it started.

If anyone else wants to participate as well in this task, then we can team
up to complete it quickly.

Let me know if you guys are interested.

Thank you.


-- 
Muhammad Shahzad
-----------------------------------
CISCO Rich Media Communication Specialist (CRMCS)
CISCO Certified Network Associate (CCNA)
Cell: +92 334 422 40 88
MSN: shari_786pk at hotmail.com
Email: shaheryarkh at googlemail.com
-------------- next part --------------
An HTML attachment was scrubbed...
URL: http://lists.freeswitch.org/pipermail/freeswitch-dev/attachments/20090918/322eb73b/attachment-0001.html 


More information about the FreeSWITCH-dev mailing list