[Freeswitch-dev] FreeSWITCH Documentation

Mon Sep 21 10:02:41 PDT 2009

Sure, i fully understand this role and its responsibilities. I will take
special care for SVN commit process.

Anyways, here is a rough plan for the project. I hope this ensures code
integrity at all levels.

1. Doxygen configuration files and directories setup.
2. Then we will do header files documentation folder by folder, starting
from inner most include directory (<FSROOT>/src/include/private) and then
moving outwards.
3. Once one whole include folder is documented, we will first put it in our
test environment and rebuild FS from scretch (i.e. after doing a distclean).
4. One of my team member has promised me to provide a script that will run
on each header file to produce a clean file (i.e. without any comments
etc.). We will run it on both original (undocumented) and modified
(documented) files and then do a diff on their output. If diff yeilds
nothing then both documented and undocumented files are identical (code
wise).
5. When all files in a single folder pass this script test, I will commit it
to SVN (alternatively i can forward them to you guys for review and then you
can commit it to SVN).
6. Once all header files are done, we then do source code files repeating
steps 3 - 5 for each folder in top most to inner most direction.

I haven't finalized resource allocation and time lines yet. However, the
documentation will be mostly done by project members while i will do steps
3-5 personally.

Please review and give your feedback.

Thank you.

On Mon, Sep 21, 2009 at 10:05 PM, Anthony Minessale <
anthony.minessale at gmail.com> wrote:

> yah and since committing to header files will trigger a full core rebuild,
> limit it to one big patch at a time preferably at night.
>
>
> On Mon, Sep 21, 2009 at 10:58 AM, Michael Jerris <mike at jerris.com> wrote:
>
>> 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.
>>>>>>>
>>>>>>>
>>> --
>>
>>
>> _______________________________________________
>> 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
>>
>>
>
>
> --
> Anthony Minessale II
>
> FreeSWITCH http://www.freeswitch.org/
> ClueCon http://www.cluecon.com/
> Twitter: http://twitter.com/FreeSWITCH_wire
>
> AIM: anthm
> MSN:anthony_minessale at hotmail.com <MSN%3Aanthony_minessale at hotmail.com>
> GTALK/JABBER/PAYPAL:anthony.minessale at gmail.com<PAYPAL%3Aanthony.minessale at gmail.com>
> IRC: irc.freenode.net #freeswitch
>
> FreeSWITCH Developer Conference
> sip:888 at conference.freeswitch.org <sip%3A888 at conference.freeswitch.org>
> iax:guest at conference.freeswitch.org/888
> googletalk:conf+888 at conference.freeswitch.org<googletalk%3Aconf%2B888 at conference.freeswitch.org>
> pstn:213-799-1400
>
> _______________________________________________
> 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
>
>

-- 
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/20090921/53458a93/attachment.html 