[Freeswitch-dev] Doxygen configuration
Anthony Minessale
anthony.minessale at gmail.com
Fri Oct 2 10:53:47 PDT 2009
you didnt miss it actually it's not even half over.
On Fri, Oct 2, 2009 at 12:38 PM, Muhammad Shahzad <
shaheryarkh at googlemail.com> wrote:
> I was traveling and missed the conference call again, damn!
>
> Anyways, please note that only doxygen configuration file is updated and
> committed to SVN. No source code docs are added yet, though i have a few in
> pipe line, waiting to be cleared by QA guys.
>
> Thank you.
>
>
>
> On Fri, Oct 2, 2009 at 9:06 PM, Michael Collins <msc at freeswitch.org>wrote:
>
>> We are gonna talk about this during the conf call today and see if we can
>> get more specifics.
>> -MC
>>
>>
>> On Fri, Oct 2, 2009 at 2:19 AM, Muhammad Shahzad <
>> shaheryarkh at googlemail.com> wrote:
>>
>>> Sorry for delayed reply, i was busy with second set of docs for this
>>> project. Unfortunately, it still isn't ready for SVN commit, and need some
>>> fixes. Hopefully i will upload them by next Tuesday evening.
>>>
>>> Anyways, you are right i couldn't quite understand what you mean? Perhaps
>>> you are referring to list of methods calling a specific method or variable.
>>> At this point, i can't help much, i know currently the docs look somewhat
>>> confusing and this is what i am trying to correct by doing proper
>>> documentation of FS source code.
>>>
>>> As for missing functions in documentation, i can assure you no previous
>>> docs were removed, only new files that are documented or needs to be
>>> documented are add to the docs tree. It is possible that some files or
>>> identifier documentation locations are changed in new documentation tree but
>>> it will be there for sure.
>>>
>>> If you feel something is relocated to wrong location in docs tree then
>>> kindly list them here, so i look at their previous and new position and
>>> correct them as necessary.
>>>
>>> Also look at diagrams at the top of each file, they provide very useful
>>> visual representation and inheritance details of each file / identifier.
>>>
>>> Thank you.
>>>
>>>
>>> On Wed, Sep 30, 2009 at 3:25 AM, Yossi Neiman <
>>> freeswitch at cartissolutions.com> wrote:
>>>
>>>> Muhammad,
>>>>
>>>> I don't think you're understanding what the issue is that I'm having.
>>>> I'm writing code in C right now. I want to be able to read the docs for
>>>> the C api by itself. I don't want to have to sift through swig and C++
>>>> etc in order to find the appropriate information about the appropriate C
>>>> functions that I'm working with. And this does not address the fact
>>>> that several functions that were visible in the documentation a couple
>>>> weeks ago are now missing from the docs pages. Those are missing from
>>>> Modules->Core Library (the examples I gave were from IVR Library and IVR
>>>> Menu Library). These functions are in FSROOT/src. While they can still
>>>> be found by looking directly at the header files under File List, I much
>>>> preferred looking up these C functions and data types by Modules->Core
>>>> Library, as it provides a more contextual arrangement to locate the
>>>> functions.
>>>>
>>>> --
>>>> Yossi Neiman
>>>> Cartis Solutions, Inc.
>>>> http://www.cartissolutions.com
>>>>
>>>>
>>>>
>>>> Muhammad Shahzad wrote:
>>>> > The primary objective of this documentation is to give full view of FS
>>>> > and its module regardless of programming language, as at many places
>>>> > especially in the language modules, source code files from different
>>>> > programming languages fit together with each other like a jigsaw
>>>> > puzzle to complete the picture (i.e. module functionality). Breaking
>>>> > the directory hierarchy on programming language basis would not give
>>>> > the actual composition of module, thus confusing the developers who
>>>> > wants to write up new language modules.
>>>> >
>>>> > We are documenting everything that is inside <FSROOT>/src folder plus
>>>> > 4 directories in <FSROOT>/libs folder, which are maintained by FS
>>>> > developer community, these are,
>>>> >
>>>> > libdingaling
>>>> > libteletone
>>>> > openzap
>>>> > esl
>>>> >
>>>> > So, i think i am covering entire code base. If you think i am missing
>>>> > something, kindly send me relative path with respect to FSROOT, for
>>>> > example,
>>>> >
>>>> > <FSROOT>/libs/libdingaling
>>>> >
>>>> > Thank you.
>>>> >
>>>> >
>>>> > On Tue, Sep 29, 2009 at 11:33 PM, Yossi Neiman
>>>> > <freeswitch at cartissolutions.com
>>>> > <mailto:freeswitch at cartissolutions.com>> wrote:
>>>> >
>>>> > Muhammad,
>>>> >
>>>> > I and many others appreciate the work you are doing on the API
>>>> > docs. I
>>>> > did want to make a request, based upon what I've been seeing on
>>>> the
>>>> > docs.freeswitch.org <http://docs.freeswitch.org> pages recently.
>>>> > Would it be possible to split out
>>>> > the documentation based upon language involved? My eyes are
>>>> getting
>>>> > cluttered with swig and C++ docs mixed in with the C docs, and
>>>> it's
>>>> > making it a little difficult for me to find what I am looking for.
>>>> I
>>>> > can see this helping other folks as well, since I think that
>>>> others
>>>> > would also want to see only docs pertaining to the language that
>>>> they
>>>> > are currently working in.
>>>> >
>>>> > I also have the feeling that some/many of the functions that were
>>>> > previously listed under the Modules->Core Library. For example,
>>>> we're
>>>> > missing a whole bunch of functions that were previously shown
>>>> > under the
>>>> > IVR Library and IVR Menu Library.
>>>> >
>>>> > Thanks,
>>>> >
>>>> > --
>>>> > Yossi Neiman
>>>> > Cartis Solutions, Inc.
>>>> > http://www.cartissolutions.com
>>>> >
>>>> >
>>>> >
>>>> > Muhammad Shahzad wrote:
>>>> > > Hi,
>>>> > >
>>>> > > Please see attached herewith doxygen configuration file for FS
>>>> > > documentation. this should replace the one found at
>>>> > > <FSROOT>/docs/Doxygen.conf.
>>>> > >
>>>> > > It has following additional features,
>>>> > >
>>>> > > 1. Search Engine support, with which you can search any
>>>> identifier
>>>> > > within entire documentation tree.
>>>> > > 2. Various graphs and diagrams to illustrate position and
>>>> importance
>>>> > > of each file and how all files within a library fit together to
>>>> > > provide specific functionality.
>>>> > > 3. Name Space list, along with complete alphabetical index of
>>>> all
>>>> > > methods in them.
>>>> > > 4. Documentation coverage for all FreeSWITCH modules (previously
>>>> it
>>>> > > only generates documentation for application modules).
>>>> > > 5. Documentation for all libraries maintained by FS developers
>>>> (ESL,
>>>> > > Dingaling, Teletone and Openzap).
>>>> > > 6. Todo list.
>>>> > > 7. Links to access fully formated source code of each file with
>>>> line
>>>> > > numbers and syntax highlighting etc.
>>>> > > 8. Identifier cross reference list, i.e. a list of all methods
>>>> and
>>>> > > variable who call a given method or variable.
>>>> > > 9. UML style inheritance and collaboration diagrams.
>>>> > > 10. Configuration for LATEX, RTF and Microsoft CHM formats also
>>>> > > available but not enabled. Any developer who wish to have
>>>> > > documentation in any of these format may find and enable one or
>>>> more
>>>> > > of these formats as per his/her requirements.
>>>> > >
>>>> > > Please review and add it to FS trunk.
>>>> > >
>>>> > > All comments and suggestions are welcome.
>>>> > >
>>>> > > 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 <mailto:shari_786pk at hotmail.com>
>>>> > <mailto:shari_786pk at hotmail.com <mailto:shari_786pk at hotmail.com>>
>>>> > > Email: shaheryarkh at googlemail.com
>>>> > <mailto:shaheryarkh at googlemail.com>
>>>> > <mailto:shaheryarkh at googlemail.com
>>>> > <mailto:shaheryarkh at googlemail.com>>
>>>> > >
>>>> >
>>>> ------------------------------------------------------------------------
>>>> > >
>>>> > > _______________________________________________
>>>> > > FreeSWITCH-dev mailing list
>>>> > > FreeSWITCH-dev at lists.freeswitch.org
>>>> > <mailto: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
>>>> >
>>>> > --
>>>> > Yossi Neiman
>>>> > President
>>>> > Cartis Solutions, Inc.
>>>> > P) 630-259-8100
>>>> > http://www.cartissolutions.com
>>>> >
>>>> >
>>>> > _______________________________________________
>>>> > FreeSWITCH-dev mailing list
>>>> > FreeSWITCH-dev at lists.freeswitch.org
>>>> > <mailto: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
>>>> >
>>>> >
>>>> >
>>>> >
>>>> > --
>>>> > ________________________________________________________
>>>> > |
>>>> > |
>>>> > | FATAL ERROR
>>>> > --- O X |
>>>> > |_______________________________________________________|
>>>> > | You have moved the mouse.
>>>> > |
>>>> > | Windows must be restarted for the changes to take effect. |
>>>> > | <OK>
>>>> > |
>>>> > ####################################/
>>>> >
>>>> >
>>>> > 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 <mailto:shari_786pk at hotmail.com>
>>>> > Email: shaheryarkh at googlemail.com <mailto: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
>>>> >
>>>>
>>>> --
>>>> Yossi Neiman
>>>> President
>>>> Cartis Solutions, Inc.
>>>> P) 630-259-8100
>>>> http://www.cartissolutions.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
>>>>
>>>
>>>
>>>
>>> --
>>> ________________________________________________________
>>> |
>>> |
>>> | FATAL ERROR
>>> --- O X |
>>> |_______________________________________________________|
>>> | You have moved the mouse.
>>> |
>>> | Windows must be restarted for the changes to take effect. |
>>> | <OK>
>>> |
>>> ####################################/
>>>
>>>
>>> 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
>>>
>>>
>>
>> _______________________________________________
>> 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
>>
>>
>
>
> --
> ________________________________________________________
> |
> |
> | FATAL ERROR ---
> O X |
> |_______________________________________________________|
> | You have moved the mouse.
> |
> | Windows must be restarted for the changes to take effect. |
> | <OK>
> |
> ####################################/
>
>
> 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
>
>
--
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
-------------- next part --------------
An HTML attachment was scrubbed...
URL: http://lists.freeswitch.org/pipermail/freeswitch-dev/attachments/20091002/f83e4841/attachment-0001.html
More information about the FreeSWITCH-dev
mailing list