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 Email: shaheryarkh@googlemail.com
Any update on this? Thank you. On Wed, Sep 23, 2009 at 11:48 PM, Muhammad Shahzad < shaheryarkh@googlemail.com> 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 Email: shaheryarkh@googlemail.com
-- ________________________________________________________ | | | 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 Email: shaheryarkh@googlemail.com
It'll be here shortly http://docs.freeswitch.org/ this seems to take A LOT longer to run. /b On Sep 24, 2009, at 11:58 PM, Muhammad Shahzad wrote:
Any update on this?
Thank you.
It takes approximately 15 minutes on 1.6 GHz P-4 with 1 GB RAM. This is due to complex graphs it generates for referencing. Thank you. On Fri, Sep 25, 2009 at 11:21 AM, Brian West <brian@freeswitch.org> wrote:
It'll be here shortly http://docs.freeswitch.org/ this seems to take A LOT longer to run.
/b
On Sep 24, 2009, at 11:58 PM, Muhammad Shahzad wrote:
Any update on this?
Thank you.
_______________________________________________ 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
-- ________________________________________________________ | | | 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 Email: shaheryarkh@googlemail.com
look and feel of generated docs are pretty different then what i have on my test machine. The graphs are not working at all. Have you modified it or graphs library graphviz is missing at docs.freeswitch.org? Thank you. On Fri, Sep 25, 2009 at 11:29 AM, Muhammad Shahzad < shaheryarkh@googlemail.com> wrote:
It takes approximately 15 minutes on 1.6 GHz P-4 with 1 GB RAM. This is due to complex graphs it generates for referencing.
Thank you.
On Fri, Sep 25, 2009 at 11:21 AM, Brian West <brian@freeswitch.org> wrote:
It'll be here shortly http://docs.freeswitch.org/ this seems to take A LOT longer to run.
/b
On Sep 24, 2009, at 11:58 PM, Muhammad Shahzad wrote:
Any update on this?
Thank you.
_______________________________________________ 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
-- ________________________________________________________ | | | 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 Email: shaheryarkh@googlemail.com
-- ________________________________________________________ | | | 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 Email: shaheryarkh@googlemail.com
I'll check first thing in the morning! Sent from my iPhone On Sep 25, 2009, at 12:51 AM, Muhammad Shahzad <shaheryarkh@googlemail.com
wrote:
look and feel of generated docs are pretty different then what i have on my test machine. The graphs are not working at all.
Have you modified it or graphs library graphviz is missing at docs.freeswitch.org ?
Thank you.
On Fri, Sep 25, 2009 at 11:29 AM, Muhammad Shahzad <shaheryarkh@googlemail.com
wrote: It takes approximately 15 minutes on 1.6 GHz P-4 with 1 GB RAM. This is due to complex graphs it generates for referencing.
Thank you.
On Fri, Sep 25, 2009 at 11:21 AM, Brian West <brian@freeswitch.org> wrote: It'll be here shortly http://docs.freeswitch.org/ this seems to take A LOT longer to run.
/b
On Sep 24, 2009, at 11:58 PM, Muhammad Shahzad wrote:
Any update on this?
Thank you.
_______________________________________________ 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
-- ________________________________________________________ |
| | 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 Email: shaheryarkh@googlemail.com
-- ________________________________________________________ |
| | 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 Email: 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
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 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> 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
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> 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 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> 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
_______________________________________________ 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
-- ________________________________________________________ | | | 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 Email: shaheryarkh@googlemail.com
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
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@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@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
-- 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
-- ________________________________________________________ | | | 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
_______________________________________________ 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
-- ________________________________________________________ | | | 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 Email: shaheryarkh@googlemail.com
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@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@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@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
-- 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
-- ________________________________________________________ | | | 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
_______________________________________________ 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
-- ________________________________________________________ | | | 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 Email: 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
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@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@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@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@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
-- 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
-- ________________________________________________________ | | | 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
_______________________________________________ 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
-- ________________________________________________________ | | | 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 Email: 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
_______________________________________________ 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
-- ________________________________________________________ | | | 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 Email: shaheryarkh@googlemail.com
The conf is still going it lasts 6 hours . /b On Oct 2, 2009, at 12:38 PM, Muhammad Shahzad 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.
you didnt miss it actually it's not even half over. On Fri, Oct 2, 2009 at 12:38 PM, Muhammad Shahzad < shaheryarkh@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@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@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@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@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
-- 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
-- ________________________________________________________ | | | 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
-- Yossi Neiman President Cartis Solutions, Inc. P) 630-259-8100 http://www.cartissolutions.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
-- ________________________________________________________ | | | 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 Email: 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
_______________________________________________ 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
-- ________________________________________________________ | | | 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 Email: 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
-- Anthony Minessale II FreeSWITCH http://www.freeswitch.org/ ClueCon http://www.cluecon.com/ Twitter: http://twitter.com/FreeSWITCH_wire AIM: anthm MSN:anthony_minessale@hotmail.com <MSN%3Aanthony_minessale@hotmail.com> GTALK/JABBER/PAYPAL:anthony.minessale@gmail.com<PAYPAL%3Aanthony.minessale@gmail.com> IRC: irc.freenode.net #freeswitch FreeSWITCH Developer Conference sip:888@conference.freeswitch.org <sip%3A888@conference.freeswitch.org> iax:guest@conference.freeswitch.org/888 googletalk:conf+888@conference.freeswitch.org<googletalk%3Aconf%2B888@conference.freeswitch.org> pstn:213-799-1400
Muhammad - I have put up the doxygen generated documents up on my company's website temporarily. I have a comparison for you between SVN version 14798 and 15184 located in http://www.cartissolutions.com/freeswitch . What I want you to do is look at, for example, Modules->Core Library->IVR Library and its subsection of IVR Menu Library. You will clearly see that there are a significant number of missing functions in the r15184 version, while they are showing up in the r14798 (just prior to your initial commits I believe). Another example is under Modules->Brought to you by APR->Time Functions. You will see *no* functions listed for the r15184 version of the documents. I hope this clarifies for you what difficulties I've been having with the documentation. Thanks, -- Yossi Neiman Cartis Solutions, Inc. - http://www.cartissolutions.com Muhammad Shahzad 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@cartissolutions.com <mailto:freeswitch@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@cartissolutions.com <mailto:freeswitch@cartissolutions.com> > <mailto: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> <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>> > <mailto: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>> > <mailto: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> > <mailto: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> > <mailto: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> <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
On Wed, Oct 21, 2009 at 10:57 AM, Yossi Neiman < freeswitch@cartissolutions.com> wrote:
Muhammad -
I have put up the doxygen generated documents up on my company's website temporarily. I have a comparison for you between SVN version 14798 and 15184 located in http://www.cartissolutions.com/freeswitch . What I want you to do is look at, for example, Modules->Core Library->IVR Library and its subsection of IVR Menu Library. You will clearly see that there are a significant number of missing functions in the r15184 version, while they are showing up in the r14798 (just prior to your initial commits I believe). Another example is under Modules->Brought to you by APR->Time Functions. You will see *no* functions listed for the r15184 version of the documents.
I hope this clarifies for you what difficulties I've been having with the documentation.
Thanks,
-- Yossi Neiman Cartis Solutions, Inc. - http://www.cartissolutions.com
Yossi, Thanks for doing the legwork on this. Muhammad, the FS devs and power users are available to assist if you have any questions. -MC
Thanks for your efforts Yossi. As per my last conversation with Athum, i have put IVR library on top priority and currently working on that. Anyways, let me compare the two docs and get back to you. Thank you. On Thu, Oct 22, 2009 at 12:56 AM, Michael Collins <msc@freeswitch.org>wrote:
On Wed, Oct 21, 2009 at 10:57 AM, Yossi Neiman < freeswitch@cartissolutions.com> wrote:
Muhammad -
I have put up the doxygen generated documents up on my company's website temporarily. I have a comparison for you between SVN version 14798 and 15184 located in http://www.cartissolutions.com/freeswitch . What I want you to do is look at, for example, Modules->Core Library->IVR Library and its subsection of IVR Menu Library. You will clearly see that there are a significant number of missing functions in the r15184 version, while they are showing up in the r14798 (just prior to your initial commits I believe). Another example is under Modules->Brought to you by APR->Time Functions. You will see *no* functions listed for the r15184 version of the documents.
I hope this clarifies for you what difficulties I've been having with the documentation.
Thanks,
-- Yossi Neiman Cartis Solutions, Inc. - http://www.cartissolutions.com
Yossi,
Thanks for doing the legwork on this. Muhammad, the FS devs and power users are available to assist if you have any questions. -MC
_______________________________________________ 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
-- ________________________________________________________ | | | 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 Email: shaheryarkh@googlemail.com
Ok, I have found three issues, which are most likely causing trouble for you. 1. The Doxygen.conf file that i committed in SVN, was generated for Doxygen version 1.6.1, while you are using doxygen version 1.4.x. Therefore, following a lot of tags are not repected by doxygen, for example, when i installed and executed doxygen 1.4.0, i get following warnings in Doxygen.conf file, these don't appear when using doxygen version 1.6.x. Warning: ignoring unsupported tag `DOXYFILE_ENCODING =' at line 23, file Doxygen.conf Warning: ignoring unsupported tag `QT_AUTOBRIEF =' at line 148, file Doxygen.conf Warning: ignoring unsupported tag `OPTIMIZE_FOR_FORTRAN =' at line 202, file Doxygen.conf Warning: ignoring unsupported tag `OPTIMIZE_OUTPUT_VHDL =' at line 208, file Doxygen.conf Warning: ignoring unsupported tag `EXTENSION_MAPPING =' at line 219, file Doxygen.conf Warning: ignoring unsupported tag `CPP_CLI_SUPPORT =' at line 233, file Doxygen.conf Warning: ignoring unsupported tag `SIP_SUPPORT =' at line 239, file Doxygen.conf Warning: ignoring unsupported tag `IDL_PROPERTY_SUPPORT =' at line 248, file Doxygen.conf Warning: ignoring unsupported tag `TYPEDEF_HIDES_STRUCT =' at line 273, file Doxygen.conf Warning: ignoring unsupported tag `SYMBOL_CACHE_SIZE =' at line 289, file Doxygen.conf Warning: ignoring unsupported tag `EXTRACT_ANON_NSPACES =' at line 331, file Doxygen.conf Warning: ignoring unsupported tag `SORT_MEMBERS_CTORS_1ST =' at line 410, file Doxygen.conf Warning: ignoring unsupported tag `SORT_GROUP_NAMES =' at line 416, file Doxygen.conf Warning: ignoring unsupported tag `SHOW_FILES =' at line 483, file Doxygen.conf Warning: ignoring unsupported tag `SHOW_NAMESPACES =' at line 490, file Doxygen.conf Warning: ignoring unsupported tag `LAYOUT_FILE =' at line 509, file Doxygen.conf Warning: ignoring unsupported tag `INPUT_ENCODING =' at line 580, file Doxygen.conf Warning: ignoring unsupported tag `EXCLUDE_SYMBOLS =' at line 623, file Doxygen.conf Warning: ignoring unsupported tag `HTML_DYNAMIC_SECTIONS =' at line 812, file Doxygen.conf Warning: ignoring unsupported tag `GENERATE_DOCSET =' at line 824, file Doxygen.conf Warning: ignoring unsupported tag `DOCSET_FEEDNAME =' at line 831, file Doxygen.conf Warning: ignoring unsupported tag `DOCSET_BUNDLE_ID =' at line 838, file Doxygen.conf Warning: ignoring unsupported tag `CHM_INDEX_ENCODING =' at line 871, file Doxygen.conf Warning: ignoring unsupported tag `GENERATE_QHP =' at line 889, file Doxygen.conf Warning: ignoring unsupported tag `QCH_FILE =' at line 895, file Doxygen.conf Warning: ignoring unsupported tag `QHP_NAMESPACE =' at line 901, file Doxygen.conf Warning: ignoring unsupported tag `QHP_VIRTUAL_FOLDER =' at line 907, file Doxygen.conf Warning: ignoring unsupported tag `QHP_CUST_FILTER_NAME =' at line 913, file Doxygen.conf Warning: ignoring unsupported tag `QHP_CUST_FILTER_ATTRS =' at line 918, file Doxygen.conf Warning: ignoring unsupported tag `QHP_SECT_FILTER_ATTRS =' at line 924, file Doxygen.conf Warning: ignoring unsupported tag `QHG_LOCATION =' at line 931, file Doxygen.conf Warning: ignoring unsupported tag `USE_INLINE_TREES =' at line 957, file Doxygen.conf Warning: ignoring unsupported tag `FORMULA_FONTSIZE =' at line 971, file Doxygen.conf Warning: ignoring unsupported tag `LATEX_SOURCE_CODE =' at line 1058, file Doxygen.conf Warning: ignoring unsupported tag `MSCGEN_PATH =' at line 1351, file Doxygen.conf Warning: ignoring unsupported tag `DOT_FONTNAME =' at line 1375, file Doxygen.conf Warning: ignoring unsupported tag `DOT_FONTSIZE =' at line 1380, file Doxygen.conf Warning: ignoring unsupported tag `DOT_FONTPATH =' at line 1387, file Doxygen.conf Warning: ignoring unsupported tag `DOT_GRAPH_MAX_NODES =' at line 1486, file Doxygen.conf 2. At least one library path has change since my commit to SVN, Warning: tag INCLUDE_PATH: include path `../libs/voipcodecs' does not exist Searching for include files... Error: source ../libs/voipcodecs is not a readable file or directory... skipping. 3. A lot of warnings like below, either developer has changed doxy comments in source files without checking the groups hierarchy etc. or doxygen version conflict is causing these problems. /usr/src/svn-src/freeswitch/src/include/switch_apr.h:105: Warning: Member documentation for SWITCH_DECLARE found several times in @defgroup groups! /usr/src/svn-src/freeswitch/src/include/switch_apr.h:274: The member will remain in group switch_dso, and won't be put into group switch_time /usr/src/svn-src/freeswitch/src/include/switch_apr.h:105: Warning: Member documentation for SWITCH_DECLARE found several times in @defgroup groups! /usr/src/svn-src/freeswitch/src/include/switch_apr.h:284: The member will remain in group switch_dso, and won't be put into group switch_time /usr/src/svn-src/freeswitch/src/include/switch_apr.h:105: Warning: Member documentation for SWITCH_DECLARE found several times in @defgroup groups! /usr/src/svn-src/freeswitch/src/include/switch_apr.h:294: The member will remain in group switch_dso, and won't be put into group switch_time /usr/src/svn-src/freeswitch/src/include/switch_apr.h:105: Warning: Member documentation for SWITCH_DECLARE found several times in @defgroup groups! /usr/src/svn-src/freeswitch/src/include/switch_apr.h:304: The member will remain in group switch_dso, and won't be put into group switch_time /usr/src/svn-src/freeswitch/src/include/switch_apr.h:105: Warning: Member documentation for SWITCH_DECLARE found several times in @defgroup groups! /usr/src/svn-src/freeswitch/src/include/switch_apr.h:311: The member will remain in group switch_dso, and won't be put into group switch_time /usr/src/svn-src/freeswitch/src/include/switch_apr.h:105: Warning: Member documentation for SWITCH_DECLARE found several times in @defgroup groups! /usr/src/svn-src/freeswitch/src/include/switch_apr.h:319: The member will remain in group switch_dso, and won't be put into group switch_time /usr/src/svn-src/freeswitch/src/include/switch_apr.h:105: Warning: Member documentation for SWITCH_DECLARE found several times in @defgroup groups! /usr/src/svn-src/freeswitch/src/include/switch_apr.h:326: The member will remain in group switch_dso, and won't be put into group switch_time /usr/src/svn-src/freeswitch/src/include/switch_apr.h:105: Warning: Member documentation for SWITCH_DECLARE found several times in @defgroup groups! /usr/src/svn-src/freeswitch/src/include/switch_apr.h:333: The member will remain in group switch_dso, and won't be put into group switch_time /usr/src/svn-src/freeswitch/src/include/switch_apr.h:78: Warning: Member documentation for SWITCH_DECLARE found several times in @defgroup groups! Now i would like to ask FS developers which doxygen version i should use for documentation? The one i am using is most recent stable version of doxygen released on August 25, 2009. For Yossi, i am afraid no quick fix is available, as i already told you that i am working on IVR library and trying to finish it as soon as possible, so you can fully enjoy browsing through docs. However, if you still want to see things old way, you can put old Doxygen.conf file in <FS-trunk>/docs folder and generate docs again, but this is a temporary solution. Thank you. On Thu, Oct 22, 2009 at 11:47 AM, Muhammad Shahzad < shaheryarkh@googlemail.com> wrote:
Thanks for your efforts Yossi.
As per my last conversation with Athum, i have put IVR library on top priority and currently working on that. Anyways, let me compare the two docs and get back to you.
Thank you.
On Thu, Oct 22, 2009 at 12:56 AM, Michael Collins <msc@freeswitch.org>wrote:
On Wed, Oct 21, 2009 at 10:57 AM, Yossi Neiman < freeswitch@cartissolutions.com> wrote:
Muhammad -
I have put up the doxygen generated documents up on my company's website temporarily. I have a comparison for you between SVN version 14798 and 15184 located in http://www.cartissolutions.com/freeswitch . What I want you to do is look at, for example, Modules->Core Library->IVR Library and its subsection of IVR Menu Library. You will clearly see that there are a significant number of missing functions in the r15184 version, while they are showing up in the r14798 (just prior to your initial commits I believe). Another example is under Modules->Brought to you by APR->Time Functions. You will see *no* functions listed for the r15184 version of the documents.
I hope this clarifies for you what difficulties I've been having with the documentation.
Thanks,
-- Yossi Neiman Cartis Solutions, Inc. - http://www.cartissolutions.com
Yossi,
Thanks for doing the legwork on this. Muhammad, the FS devs and power users are available to assist if you have any questions. -MC
_______________________________________________ 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
-- ________________________________________________________ | | | 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 Email: shaheryarkh@googlemail.com
-- ________________________________________________________ | | | 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 Email: shaheryarkh@googlemail.com
On Oct 22, 2009, at 3:45 AM, Muhammad Shahzad wrote:
Ok, I have found three issues, which are most likely causing trouble for you.
1. The Doxygen.conf file that i committed in SVN, was generated for Doxygen version 1.6.1, while you are using doxygen version 1.4.x. Therefore, following a lot of tags are not repected by doxygen, for example, when i installed and executed doxygen 1.4.0, i get following warnings in Doxygen.conf file, these don't appear when using doxygen version 1.6.x.
considering that we're using 1.4.7 on docs.freeswitch.org, it might be a good idea to make the doxygen.conf work for the 1.4.x version(s) unless i'm missing something (which is quite possible), then it seems that 1.4.7 is the latest stable from centos right now. with all of the things we already have to keep up with, it doesn't make sense for us to have to manually install/upgrade doxygen from source too. Raymond Chandler http://freeswitchsolutions.com http://cluecon.com http://cudatel.com
Humm, ok i normally use Gentoo as my development platform, though most of my servers run CentOS. Both have different default versions for different software but i never observed much of compatibility issues. Anyways, let me check default CentOS doxygen version and build configuration file for it, assuming CentOS as our (FreeSWITCH's) official OS? Thank you. On Thu, Oct 22, 2009 at 9:11 PM, Raymond Chandler < intralanman@freeswitch.org> wrote:
On Oct 22, 2009, at 3:45 AM, Muhammad Shahzad wrote:
Ok, I have found three issues, which are most likely causing trouble for you.
1. The Doxygen.conf file that i committed in SVN, was generated for Doxygen version 1.6.1, while you are using doxygen version 1.4.x. Therefore, following a lot of tags are not repected by doxygen, for example, when i installed and executed doxygen 1.4.0, i get following warnings in Doxygen.conf file, these don't appear when using doxygen version 1.6.x.
considering that we're using 1.4.7 on docs.freeswitch.org, it might be a good idea to make the doxygen.conf work for the 1.4.x version(s)
unless i'm missing something (which is quite possible), then it seems that 1.4.7 is the latest stable from centos right now.
with all of the things we already have to keep up with, it doesn't make sense for us to have to manually install/upgrade doxygen from source too.
Raymond Chandler http://freeswitchsolutions.com http://cluecon.com http://cudatel.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
-- Muhammad Shahzad ----------------------------------- CISCO Rich Media Communication Specialist (CRMCS) CISCO Certified Network Associate (CCNA) Cell: +92 334 422 40 88 MSN: shari_786pk@hotmail.com Email: shaheryarkh@googlemail.com
Slackware and Slackware-based distros seem to be using the 1.5.x tree. Seems that something in the 1.6.x tree has changed the behavior of doxygen. I'd suggest that when you fix up the doxygen.conf for the 1.4.x tree that you make sure that the 1.6.x tree can still generate proper documents from that too. (And if not possible, maybe have a doxygen.conf for 1.5.x and prior and another for 1.6.x and newer.) -- Yossi Neiman Cartis Solutions, Inc. - http://www.cartissolutions.com Muhammad Shahzad wrote:
Humm, ok i normally use Gentoo as my development platform, though most of my servers run CentOS. Both have different default versions for different software but i never observed much of compatibility issues.
Anyways, let me check default CentOS doxygen version and build configuration file for it, assuming CentOS as our (FreeSWITCH's) official OS?
Thank you.
On Thu, Oct 22, 2009 at 9:11 PM, Raymond Chandler <intralanman@freeswitch.org <mailto:intralanman@freeswitch.org>> wrote:
On Oct 22, 2009, at 3:45 AM, Muhammad Shahzad wrote:
> Ok, I have found three issues, which are most likely causing trouble > for you. > > 1. The Doxygen.conf file that i committed in SVN, was generated for > Doxygen version 1.6.1, while you are using doxygen version 1.4.x. > Therefore, following a lot of tags are not repected by doxygen, for > example, when i installed and executed doxygen 1.4.0, i get > following warnings in Doxygen.conf file, these don't appear when > using doxygen version 1.6.x.
considering that we're using 1.4.7 on docs.freeswitch.org <http://docs.freeswitch.org>, it might be a good idea to make the doxygen.conf work for the 1.4.x version(s)
unless i'm missing something (which is quite possible), then it seems that 1.4.7 is the latest stable from centos right now.
with all of the things we already have to keep up with, it doesn't make sense for us to have to manually install/upgrade doxygen from source too.
Raymond Chandler http://freeswitchsolutions.com http://cluecon.com http://cudatel.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
-- 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
participants (6)
-
Anthony Minessale
-
Brian West
-
Michael Collins
-
Muhammad Shahzad
-
Raymond Chandler
-
Yossi Neiman