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@cartissolutions.com <mailto:freeswitch@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@hotmail.com <mailto:shari_786pk@hotmail.com> <mailto:shari_786pk@hotmail.com <mailto:shari_786pk@hotmail.com>> > Email: shaheryarkh@googlemail.com <mailto:shaheryarkh@googlemail.com> <mailto:shaheryarkh@googlemail.com <mailto:shaheryarkh@googlemail.com>> > ------------------------------------------------------------------------ > > _______________________________________________ > FreeSWITCH-dev mailing list > FreeSWITCH-dev@lists.freeswitch.org <mailto:FreeSWITCH-dev@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@lists.freeswitch.org <mailto:FreeSWITCH-dev@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@hotmail.com <mailto:shari_786pk@hotmail.com> Email: shaheryarkh@googlemail.com <mailto:shaheryarkh@googlemail.com> ------------------------------------------------------------------------
_______________________________________________ FreeSWITCH-dev mailing list FreeSWITCH-dev@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