[Freeswitch-dev] FreeSWITCH Documentation

[Michael Jerris]

There is probably about 80% doxygen coverage on the switch_ namespace  
right now.  Of course filling in those holes is much appretiated, but  
I have a feeling there might be some other piece in understanding that  
we are missing.  Can you explain a bit more what information if you  
had would have helped?  Also, feel free to pop by irc and we can give  
some real time feedback on api.

Mike

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/31bf61f5/attachment.html