All of this can be done in doxygen, maybe with the exception of the faq which would be easier to maintain on a wiki probably.. the advantage of it being in doxygen is you can do all the examples and such inline in the code, so it is much easier tom make sure they stay up to date with the current code. Then, anyone who has the code has the ability to create a local set of docs that exactly matches the code they are currently working with, and you don't need to go to great lengths to mark what version things are for, as your scm manages that for you. Docs tarballs could be created with or in release tarballs.
Mike > -----Original Message----- > From: [EMAIL PROTECTED] [mailto:sofia-sip- > [EMAIL PROTECTED] On Behalf Of Diego Betancor > Sent: Friday, September 08, 2006 1:43 PM > To: sofia-sip-devel@lists.sourceforge.net > Subject: Re: [Sofia-sip-devel] sofsip-cli updates, odd glib error > > Hello, > > I think you are in the right track updating documentation. Sofia-sip is a > great stack but the documentation is not. If you would like people too use > and to contribute may I suggest. > > 1. Answer all questions. Few days ago I asked about a registrar (did read > the doxygen generated documentation, read the mailing list) nobode > answered. It didn't make me feel welcome. > > 2. Document the API in one place with examples. Not just put there the > doxygen, because from it is not clear at all how to use. List main > functions, list main tags in a point. Not only nua, but nta, su, soa . > Lots > of little examples. It can be in the wiki. > > 3. FAQ. Very important. How do I do this or that?. Why would I use nta and > not nua?, what is the diference in taking care of dialog, ACKs, timers?. > Could I use nua and nta at the same time?. How do I differenciate dialogs > from diferent clients?, etc. > > 4. Tutorial (as you are doing). > > 5. How to help. > > 6. Have all the documentation in a downloable tarball (or zip), so it can > be read and studied locally. > > Hope it helps, Diego > > > At 06:09 PM 9/7/06 +0300, you wrote: > >Hello again, > > > >On Fri, 25 Aug 2006, Henrik Nordstrom wrote: > > > >> Just a small comment on sofsip-cli. imho it has grown a bit too large > to > >> be considered an example. Better considered an reference application > >> using pretty much the complete stack. > > > >ok, Nickolay also raised the same point. I've now updated the website a > >bit and sofsip-cli (and the gaim plugin) are now both classified as > >reference clients. There are now more prominent links to the tutorial as > >well as to the NUA reference documentation. Comments are welcome: > > > >- http://sofia-sip.sourceforge.net/development.html > > > >I've also update the front page somewhat: > > > >- http://sofia-sip.sourceforge.net/ > > > >I added some new non-technical content to our 'Features' list. It'd be > >interesting to hear comments concerning the "Open development model" > >section. Is this project open enough? > > > >-- > > under work: Sofia-SIP at http://sofia-sip.sf.net > > > >----------------------------------------------------------------------- -- > >Using Tomcat but need to do more? Need to support web services, security? > >Get stuff done quickly with pre-integrated technology to make your job > easier > >Download IBM WebSphere Application Server v.1.0.1 based on Apache > Geronimo > >http://sel.as-us.falkag.net/sel?cmd=lnkkid=120709&bid=263057&dat=121642 > >_______________________________________________ > >Sofia-sip-devel mailing list > >Sofia-sip-devel@lists.sourceforge.net > >https://lists.sourceforge.net/lists/listinfo/sofia-sip-devel > > > > ------------------------------------------------------------------------ - > Using Tomcat but need to do more? Need to support web services, security? > Get stuff done quickly with pre-integrated technology to make your job > easier > Download IBM WebSphere Application Server v.1.0.1 based on Apache Geronimo > http://sel.as-us.falkag.net/sel?cmd=lnk&kid=120709&bid=263057&dat=121642 > _______________________________________________ > Sofia-sip-devel mailing list > Sofia-sip-devel@lists.sourceforge.net > https://lists.sourceforge.net/lists/listinfo/sofia-sip-devel ------------------------------------------------------------------------- Using Tomcat but need to do more? Need to support web services, security? Get stuff done quickly with pre-integrated technology to make your job easier Download IBM WebSphere Application Server v.1.0.1 based on Apache Geronimo http://sel.as-us.falkag.net/sel?cmd=lnk&kid=120709&bid=263057&dat=121642 _______________________________________________ Sofia-sip-devel mailing list Sofia-sip-devel@lists.sourceforge.net https://lists.sourceforge.net/lists/listinfo/sofia-sip-devel
