<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta content="text/html;charset=UTF-8" http-equiv="Content-Type">
</head>
<body bgcolor="#ffffff" text="#000000">
Muhammad -<br>
<br>
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 <a class="moz-txt-link-freetext" href="http://www.cartissolutions.com/freeswitch">http://www.cartissolutions.com/freeswitch</a> .
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.<br>
<br>
I hope this clarifies for you what difficulties I've been having with
the documentation.<br>
<br>
Thanks,<br>
<pre class="moz-signature" cols="72">--
Yossi Neiman
Cartis Solutions, Inc. - <a class="moz-txt-link-freetext" href="http://www.cartissolutions.com">http://www.cartissolutions.com</a>
</pre>
<br>
<br>
Muhammad Shahzad wrote:
<blockquote
cite="mid:b16156850910020219oa2b4a7ch26b68e52cb8a3676@mail.gmail.com"
type="cite">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.<br>
<br>
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.<br>
<br>
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.<br>
<br>
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.<br>
<br>
Also look at diagrams at the top of each file, they provide very useful
visual representation and inheritance details of each file / identifier.<br>
<br>
Thank you.<br>
<br>
<br>
<div class="gmail_quote">On Wed, Sep 30, 2009 at 3:25 AM, Yossi
Neiman <span dir="ltr"><<a moz-do-not-send="true"
href="mailto:freeswitch@cartissolutions.com">freeswitch@cartissolutions.com</a>></span>
wrote:<br>
<blockquote class="gmail_quote"
style="border-left: 1px solid rgb(204, 204, 204); margin: 0pt 0pt 0pt 0.8ex; padding-left: 1ex;">Muhammad,<br>
<br>
I don't think you're understanding what the issue is that I'm having.<br>
I'm writing code in C right now. I want to be able to read the docs for<br>
the C api by itself. I don't want to have to sift through swig and C++<br>
etc in order to find the appropriate information about the appropriate C<br>
functions that I'm working with. And this does not address the fact<br>
that several functions that were visible in the documentation a couple<br>
weeks ago are now missing from the docs pages. Those are missing from<br>
Modules->Core Library (the examples I gave were from IVR Library and
IVR<br>
Menu Library). These functions are in FSROOT/src. While they can still<br>
be found by looking directly at the header files under File List, I much<br>
preferred looking up these C functions and data types by
Modules->Core<br>
Library, as it provides a more contextual arrangement to locate the<br>
functions.<br>
<br>
--<br>
<div class="im">Yossi Neiman<br>
Cartis Solutions, Inc.<br>
<a moz-do-not-send="true" href="http://www.cartissolutions.com"
target="_blank">http://www.cartissolutions.com</a><br>
<br>
<br>
<br>
Muhammad Shahzad wrote:<br>
</div>
<div class="im">> The primary objective of this documentation is
to give full view of FS<br>
> and its module regardless of programming language, as at many
places<br>
> especially in the language modules, source code files from
different<br>
> programming languages fit together with each other like a jigsaw<br>
> puzzle to complete the picture (i.e. module functionality).
Breaking<br>
> the directory hierarchy on programming language basis would not
give<br>
> the actual composition of module, thus confusing the developers who<br>
> wants to write up new language modules.<br>
><br>
> We are documenting everything that is inside <FSROOT>/src
folder plus<br>
> 4 directories in <FSROOT>/libs folder, which are maintained
by FS<br>
> developer community, these are,<br>
><br>
> libdingaling<br>
> libteletone<br>
> openzap<br>
> esl<br>
><br>
> So, i think i am covering entire code base. If you think i am
missing<br>
> something, kindly send me relative path with respect to FSROOT, for<br>
> example,<br>
><br>
> <FSROOT>/libs/libdingaling<br>
><br>
> Thank you.<br>
><br>
><br>
> On Tue, Sep 29, 2009 at 11:33 PM, Yossi Neiman<br>
> <<a moz-do-not-send="true"
href="mailto:freeswitch@cartissolutions.com">freeswitch@cartissolutions.com</a><br>
</div>
<div class="im">> <mailto:<a moz-do-not-send="true"
href="mailto:freeswitch@cartissolutions.com">freeswitch@cartissolutions.com</a>>>
wrote:<br>
><br>
> Muhammad,<br>
><br>
> I and many others appreciate the work you are doing on the API<br>
> docs. I<br>
> did want to make a request, based upon what I've been seeing
on the<br>
</div>
> <a moz-do-not-send="true" href="http://docs.freeswitch.org"
target="_blank">docs.freeswitch.org</a> <<a moz-do-not-send="true"
href="http://docs.freeswitch.org" target="_blank">http://docs.freeswitch.org</a>>
pages recently.<br>
<div>
<div class="h5">> Would it be possible to split out<br>
> the documentation based upon language involved? My eyes are
getting<br>
> cluttered with swig and C++ docs mixed in with the C docs, and
it's<br>
> making it a little difficult for me to find what I am looking
for. I<br>
> can see this helping other folks as well, since I think that
others<br>
> would also want to see only docs pertaining to the language
that they<br>
> are currently working in.<br>
><br>
> I also have the feeling that some/many of the functions that
were<br>
> previously listed under the Modules->Core Library. For
example, we're<br>
> missing a whole bunch of functions that were previously shown<br>
> under the<br>
> IVR Library and IVR Menu Library.<br>
><br>
> Thanks,<br>
><br>
> --<br>
> Yossi Neiman<br>
> Cartis Solutions, Inc.<br>
> <a moz-do-not-send="true"
href="http://www.cartissolutions.com" target="_blank">http://www.cartissolutions.com</a><br>
><br>
><br>
><br>
> Muhammad Shahzad wrote:<br>
> > Hi,<br>
> ><br>
> > Please see attached herewith doxygen configuration file
for FS<br>
> > documentation. this should replace the one found at<br>
> > <FSROOT>/docs/Doxygen.conf.<br>
> ><br>
> > It has following additional features,<br>
> ><br>
> > 1. Search Engine support, with which you can search any
identifier<br>
> > within entire documentation tree.<br>
> > 2. Various graphs and diagrams to illustrate position and
importance<br>
> > of each file and how all files within a library fit
together to<br>
> > provide specific functionality.<br>
> > 3. Name Space list, along with complete alphabetical
index of all<br>
> > methods in them.<br>
> > 4. Documentation coverage for all FreeSWITCH modules
(previously it<br>
> > only generates documentation for application modules).<br>
> > 5. Documentation for all libraries maintained by FS
developers (ESL,<br>
> > Dingaling, Teletone and Openzap).<br>
> > 6. Todo list.<br>
> > 7. Links to access fully formated source code of each
file with line<br>
> > numbers and syntax highlighting etc.<br>
> > 8. Identifier cross reference list, i.e. a list of all
methods and<br>
> > variable who call a given method or variable.<br>
> > 9. UML style inheritance and collaboration diagrams.<br>
> > 10. Configuration for LATEX, RTF and Microsoft CHM
formats also<br>
> > available but not enabled. Any developer who wish to have<br>
> > documentation in any of these format may find and enable
one or more<br>
> > of these formats as per his/her requirements.<br>
> ><br>
> > Please review and add it to FS trunk.<br>
> ><br>
> > All comments and suggestions are welcome.<br>
> ><br>
> > Thank you.<br>
> ><br>
> ><br>
> > --<br>
> > Muhammad Shahzad<br>
> > -----------------------------------<br>
> > CISCO Rich Media Communication Specialist (CRMCS)<br>
> > CISCO Certified Network Associate (CCNA)<br>
> > Cell: +92 334 422 40 88<br>
> > MSN: <a moz-do-not-send="true"
href="mailto:shari_786pk@hotmail.com">shari_786pk@hotmail.com</a>
<mailto:<a moz-do-not-send="true"
href="mailto:shari_786pk@hotmail.com">shari_786pk@hotmail.com</a>><br>
</div>
</div>
> <mailto:<a moz-do-not-send="true"
href="mailto:shari_786pk@hotmail.com">shari_786pk@hotmail.com</a>
<mailto:<a moz-do-not-send="true"
href="mailto:shari_786pk@hotmail.com">shari_786pk@hotmail.com</a>>><br>
<div class="im">> > Email: <a moz-do-not-send="true"
href="mailto:shaheryarkh@googlemail.com">shaheryarkh@googlemail.com</a><br>
> <mailto:<a moz-do-not-send="true"
href="mailto:shaheryarkh@googlemail.com">shaheryarkh@googlemail.com</a>><br>
</div>
> <mailto:<a moz-do-not-send="true"
href="mailto:shaheryarkh@googlemail.com">shaheryarkh@googlemail.com</a><br>
<div class="im">> <mailto:<a moz-do-not-send="true"
href="mailto:shaheryarkh@googlemail.com">shaheryarkh@googlemail.com</a>>><br>
> ><br>
>
------------------------------------------------------------------------<br>
> ><br>
> > _______________________________________________<br>
> > FreeSWITCH-dev mailing list<br>
> > <a moz-do-not-send="true"
href="mailto:FreeSWITCH-dev@lists.freeswitch.org">FreeSWITCH-dev@lists.freeswitch.org</a><br>
</div>
> <mailto:<a moz-do-not-send="true"
href="mailto:FreeSWITCH-dev@lists.freeswitch.org">FreeSWITCH-dev@lists.freeswitch.org</a>><br>
<div class="im">> > <a moz-do-not-send="true"
href="http://lists.freeswitch.org/mailman/listinfo/freeswitch-dev"
target="_blank">http://lists.freeswitch.org/mailman/listinfo/freeswitch-dev</a><br>
> ><br>
> UNSUBSCRIBE:<a moz-do-not-send="true"
href="http://lists.freeswitch.org/mailman/options/freeswitch-dev"
target="_blank">http://lists.freeswitch.org/mailman/options/freeswitch-dev</a><br>
> > <a moz-do-not-send="true"
href="http://www.freeswitch.org" target="_blank">http://www.freeswitch.org</a><br>
><br>
> --<br>
> Yossi Neiman<br>
> President<br>
> Cartis Solutions, Inc.<br>
> P) 630-259-8100<br>
> <a moz-do-not-send="true"
href="http://www.cartissolutions.com" target="_blank">http://www.cartissolutions.com</a><br>
><br>
><br>
> _______________________________________________<br>
> FreeSWITCH-dev mailing list<br>
> <a moz-do-not-send="true"
href="mailto:FreeSWITCH-dev@lists.freeswitch.org">FreeSWITCH-dev@lists.freeswitch.org</a><br>
</div>
> <mailto:<a moz-do-not-send="true"
href="mailto:FreeSWITCH-dev@lists.freeswitch.org">FreeSWITCH-dev@lists.freeswitch.org</a>><br>
<div>
<div class="h5">> <a moz-do-not-send="true"
href="http://lists.freeswitch.org/mailman/listinfo/freeswitch-dev"
target="_blank">http://lists.freeswitch.org/mailman/listinfo/freeswitch-dev</a><br>
> UNSUBSCRIBE:<a moz-do-not-send="true"
href="http://lists.freeswitch.org/mailman/options/freeswitch-dev"
target="_blank">http://lists.freeswitch.org/mailman/options/freeswitch-dev</a><br>
> <a moz-do-not-send="true" href="http://www.freeswitch.org"
target="_blank">http://www.freeswitch.org</a><br>
><br>
><br>
><br>
><br>
> --<br>
> ________________________________________________________<br>
> |<br>
> |<br>
> | FATAL ERROR<br>
> --- O X |<br>
> |_______________________________________________________|<br>
> | You have moved the mouse.<br>
> |<br>
> | Windows must be restarted for the changes to take effect. |<br>
> | <OK><br>
> |<br>
> ####################################/<br>
><br>
><br>
> Muhammad Shahzad<br>
> -----------------------------------<br>
> CISCO Rich Media Communication Specialist (CRMCS)<br>
> CISCO Certified Network Associate (CCNA)<br>
> Cell: +92 334 422 40 88<br>
> MSN: <a moz-do-not-send="true"
href="mailto:shari_786pk@hotmail.com">shari_786pk@hotmail.com</a>
<mailto:<a moz-do-not-send="true"
href="mailto:shari_786pk@hotmail.com">shari_786pk@hotmail.com</a>><br>
> Email: <a moz-do-not-send="true"
href="mailto:shaheryarkh@googlemail.com">shaheryarkh@googlemail.com</a>
<mailto:<a moz-do-not-send="true"
href="mailto:shaheryarkh@googlemail.com">shaheryarkh@googlemail.com</a>><br>
>
------------------------------------------------------------------------<br>
><br>
> _______________________________________________<br>
> FreeSWITCH-dev mailing list<br>
> <a moz-do-not-send="true"
href="mailto:FreeSWITCH-dev@lists.freeswitch.org">FreeSWITCH-dev@lists.freeswitch.org</a><br>
> <a moz-do-not-send="true"
href="http://lists.freeswitch.org/mailman/listinfo/freeswitch-dev"
target="_blank">http://lists.freeswitch.org/mailman/listinfo/freeswitch-dev</a><br>
> UNSUBSCRIBE:<a moz-do-not-send="true"
href="http://lists.freeswitch.org/mailman/options/freeswitch-dev"
target="_blank">http://lists.freeswitch.org/mailman/options/freeswitch-dev</a><br>
> <a moz-do-not-send="true" href="http://www.freeswitch.org"
target="_blank">http://www.freeswitch.org</a><br>
><br>
<br>
--<br>
Yossi Neiman<br>
President<br>
Cartis Solutions, Inc.<br>
P) 630-259-8100<br>
<a moz-do-not-send="true" href="http://www.cartissolutions.com"
target="_blank">http://www.cartissolutions.com</a><br>
<br>
<br>
_______________________________________________<br>
FreeSWITCH-dev mailing list<br>
<a moz-do-not-send="true"
href="mailto:FreeSWITCH-dev@lists.freeswitch.org">FreeSWITCH-dev@lists.freeswitch.org</a><br>
<a moz-do-not-send="true"
href="http://lists.freeswitch.org/mailman/listinfo/freeswitch-dev"
target="_blank">http://lists.freeswitch.org/mailman/listinfo/freeswitch-dev</a><br>
UNSUBSCRIBE:<a moz-do-not-send="true"
href="http://lists.freeswitch.org/mailman/options/freeswitch-dev"
target="_blank">http://lists.freeswitch.org/mailman/options/freeswitch-dev</a><br>
<a moz-do-not-send="true" href="http://www.freeswitch.org"
target="_blank">http://www.freeswitch.org</a><br>
</div>
</div>
</blockquote>
</div>
<br>
<br clear="all">
<br>
-- <br>
________________________________________________________<br>
|
|<br>
| FATAL ERROR
--- O X |<br>
|_______________________________________________________|<br>
| You have moved the mouse.
|<br>
| Windows must be restarted for the changes to take effect. |<br>
| <OK>
|<br>
####################################/<br>
<br>
<br>
Muhammad Shahzad<br>
-----------------------------------<br>
CISCO Rich Media Communication Specialist (CRMCS)<br>
CISCO Certified Network Associate (CCNA)<br>
Cell: +92 334 422 40 88<br>
MSN: <a moz-do-not-send="true" href="mailto:shari_786pk@hotmail.com">shari_786pk@hotmail.com</a><br>
Email: <a moz-do-not-send="true"
href="mailto:shaheryarkh@googlemail.com">shaheryarkh@googlemail.com</a><br>
<pre wrap="">
<hr size="4" width="90%">
_______________________________________________
FreeSWITCH-dev mailing list
<a class="moz-txt-link-abbreviated" href="mailto:FreeSWITCH-dev@lists.freeswitch.org">FreeSWITCH-dev@lists.freeswitch.org</a>
<a class="moz-txt-link-freetext" href="http://lists.freeswitch.org/mailman/listinfo/freeswitch-dev">http://lists.freeswitch.org/mailman/listinfo/freeswitch-dev</a>
UNSUBSCRIBE:<a class="moz-txt-link-freetext" href="http://lists.freeswitch.org/mailman/options/freeswitch-dev">http://lists.freeswitch.org/mailman/options/freeswitch-dev</a>
<a class="moz-txt-link-freetext" href="http://www.freeswitch.org">http://www.freeswitch.org</a>
</pre>
</blockquote>
</body>
</html>