Sponsor: VoiceMeUp - Corporate & Wholesale VoIP Services

VoIP Mailing List Archives
Mailing list archives for the VoIP community
 SearchSearch 

[Freeswitch-users] FreeSWITCH Documentation


 
Post new topic   Reply to topic    VoIP Mailing List Archives Forum Index -> freeSWITCH Users
View previous topic :: View next topic  
Author Message
shahzad at vopium.com
Guest





PostPosted: Fri Sep 18, 2009 2:25 am    Post subject: [Freeswitch-users] FreeSWITCH Documentation Reply with quote

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@hotmail.com (shari_786pk@hotmail.com)
Email: shaheryarkh@googlemail.com (shaheryarkh@googlemail.com)
Back to top
mustafa.pk at gmail.com
Guest





PostPosted: Fri Sep 18, 2009 2:49 am    Post subject: [Freeswitch-users] FreeSWITCH Documentation Reply with quote

that's what i was thinking about, but you have taken it a mile ahead Smile
i would appreciate if you could help people like me to understand the
*switch* API without spending sooo much time.

would love examples along with the documentation. Neutral

-mustafa

--
Ghulam Mustafa
cell: +92 333.611.7681
sip: cyrenity@ekiga.net
mail: mustafa.pk@gmail.com
web: cyrenity.wordpress.com


Muhammad Shahzad wrote:
Quote:
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@hotmail.com <mailto:shari_786pk@hotmail.com>
Email: shaheryarkh@googlemail.com <mailto:shaheryarkh@googlemail.com>
------------------------------------------------------------------------

_______________________________________________
FreeSWITCH-users mailing list
FreeSWITCH-users@lists.freeswitch.org
http://lists.freeswitch.org/mailman/listinfo/freeswitch-users
UNSUBSCRIBE:http://lists.freeswitch.org/mailman/options/freeswitch-users
http://www.freeswitch.org



_______________________________________________
FreeSWITCH-users mailing list
FreeSWITCH-users@lists.freeswitch.org
http://lists.freeswitch.org/mailman/listinfo/freeswitch-users
UNSUBSCRIBE:http://lists.freeswitch.org/mailman/options/freeswitch-users
http://www.freeswitch.org
Back to top
Display posts from previous:   
Post new topic   Reply to topic    VoIP Mailing List Archives Forum Index -> freeSWITCH Users All times are GMT - 5 Hours
Page 1 of 1

 
Jump to:  
You cannot post new topics in this forum
You cannot reply to topics in this forum
You cannot edit your posts in this forum
You cannot delete your posts in this forum
You cannot vote in polls in this forum


Powered by phpBB © 2001, 2005 phpBB Group

VoiceMeUp - Corporate & Wholesale VoIP Services