[Freeswitch-dev] Doxygen configuration
Muhammad Shahzad
shaheryarkh at googlemail.com
Thu Oct 22 00:45:03 PDT 2009
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 at 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 at freeswitch.org>wrote:
>
>>
>>
>> On Wed, Oct 21, 2009 at 10:57 AM, Yossi Neiman <
>> freeswitch at 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 at lists.freeswitch.org
>> http://lists.freeswitch.org/mailman/listinfo/freeswitch-dev
>> UNSUBSCRIBE:http://lists.freeswitch.org/mailman/options/freeswitch-dev
>> http://www.freeswitch.org
>>
>>
>
>
> --
> ________________________________________________________
> |
> |
> | FATAL ERROR ---
> O X |
> |_______________________________________________________|
> | You have moved the mouse.
> |
> | Windows must be restarted for the changes to take effect. |
> | <OK>
> |
> ####################################/
>
>
> Muhammad Shahzad
> -----------------------------------
> CISCO Rich Media Communication Specialist (CRMCS)
> CISCO Certified Network Associate (CCNA)
> Cell: +92 334 422 40 88
> MSN: shari_786pk at hotmail.com
> Email: shaheryarkh at googlemail.com
>
--
________________________________________________________
|
|
| FATAL ERROR ---
O X |
|_______________________________________________________|
| You have moved the mouse.
|
| Windows must be restarted for the changes to take effect. |
| <OK>
|
####################################/
Muhammad Shahzad
-----------------------------------
CISCO Rich Media Communication Specialist (CRMCS)
CISCO Certified Network Associate (CCNA)
Cell: +92 334 422 40 88
MSN: shari_786pk at hotmail.com
Email: shaheryarkh at googlemail.com
-------------- next part --------------
An HTML attachment was scrubbed...
URL: http://lists.freeswitch.org/pipermail/freeswitch-dev/attachments/20091022/ed219ee7/attachment-0001.html
More information about the FreeSWITCH-dev
mailing list