[Freeswitch-dev] FreeSWITCH Documentation

[Michael Jerris]

The great thing about version control, if someone screws something up,  
we can always revert it.  That being said, its just a matter of  
restraint.  If your just doing docs, little harm can be caused.  When  
you start committing actual code, typically even for those with commit  
access we review each others patches before we check them in to tree.

Mike

On Sep 21, 2009, at 11:19 AM, Muhammad Shahzad wrote:

> That would be great if you guys can have faith in me on this. :-)
>
> Thank you.
>
>
> On Mon, Sep 21, 2009 at 8:32 PM, Anthony Minessale <anthony.minessale at gmail.com 
> > wrote:
> if you are careful we can give you svn commit so you can add it  
> yourself.
>
>
>
> On Sat, Sep 19, 2009 at 2:10 PM, Muhammad Shahzad <shaheryarkh at googlemail.com 
> > wrote:
> Hi,
>
> While i am looking at things to be done and in which order, can you  
> please define the process on how i will be submitting documentation  
> to be added in FS Trunk?
>
> Thank you.
>
>
>
> On Sat, Sep 19, 2009 at 10:00 PM, Muhammad Shahzad <shaheryarkh at googlemail.com 
> > wrote:
> Thank you so much in giving me a chance to serve the FS community.  
> Lets get things moving.
>
> Unfortunately i missed conference call due to time zone confusion,  
> silly me. Anywasy, i will make myself available for next weekly  
> meetings.
>
> If you guys would like to catch me on IRC, my nick is shaheryarkh.
>
> If anyone wants to join me in documentation project, you can email  
> at shaheryarkh at googlemail.com, so i can start distributing work  
> amoung project participants.
>
> Thank you.
>
>
>
> On Sat, Sep 19, 2009 at 1:50 AM, Michael Collins  
> <msc at freeswitch.org> wrote:
> FYI,
>
> Muhammad Shahzad has officially been deputized for two things:
> mod_dingaling maintainer
> Doxygen master
>
> :)
>
>
> On Fri, Sep 18, 2009 at 7:24 AM, Raymond Chandler <intralanman at freeswitch.org 
> > wrote:
> 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.
>
> -- 
-------------- next part --------------
An HTML attachment was scrubbed...
URL: http://lists.freeswitch.org/pipermail/freeswitch-dev/attachments/20090921/10116f68/attachment.html