[Freeswitch-dev] FreeSWITCH Documentation

[Raymond Chandler]

Things like this might be good to talk about on our weekly conference  
call. It'll be starting in about 2 hours, maybe you should join the  
call and officially volunteer to start submitting patches to jira for  
the doxygen. We could even make a new section in JIRA for Doxygen  
under that "Project System" category.

-Ray


On Sep 18, 2009, at 3:18 AM, Muhammad Shahzad wrote:

> 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
> _______________________________________________
> FreeSWITCH-dev mailing list
> FreeSWITCH-dev at lists.freeswitch.org
> http://lists.freeswitch.org/mailman/listinfo/freeswitch-dev
> UNSUBSCRIBE:http://lists.freeswitch.org/mailman/options/freeswitch-dev
> http://www.freeswitch.org

-------------- next part --------------
An HTML attachment was scrubbed...
URL: http://lists.freeswitch.org/pipermail/freeswitch-dev/attachments/20090918/8eee6f30/attachment.html