Re: [naviserver-devel] Example doctools manpage for C API ?
I guess it should have the same format as for Tcl API, we just do not have anything yet in the docs repository. Stephen Deasey wrote: Anyone got an example of a C API documented using doctools? - 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=120709bid=263057dat=121642 ___ naviserver-devel mailing list naviserver-devel@lists.sourceforge.net https://lists.sourceforge.net/lists/listinfo/naviserver-devel -- Vlad Seryakov 571 262-8608 office [EMAIL PROTECTED] http://www.crystalballinc.com/vlad/
Re: [naviserver-devel] Example doctools manpage for C API ?
On 13.11.2006, at 17:59, Stephen Deasey wrote: Anyone got an example of a C API documented using doctools? Well, my fault... AFAIK, the way of documenting C-API to be close to what we can normally see under man strstr for example (i.e. many calls documented under one manpage) is not possible to implement in doctools. That is, in the doctools as-is. I yet have to speak with Andreas from the Activestate (the author of the doctools) to see how this would be possible and what needs to be done for that. Zoran
Re: [naviserver-devel] Example doctools manpage for C API ?
why it is not possible? Zoran Vasiljevic wrote: On 13.11.2006, at 17:59, Stephen Deasey wrote: Anyone got an example of a C API documented using doctools? Well, my fault... AFAIK, the way of documenting C-API to be close to what we can normally see under man strstr for example (i.e. many calls documented under one manpage) is not possible to implement in doctools. That is, in the doctools as-is. I yet have to speak with Andreas from the Activestate (the author of the doctools) to see how this would be possible and what needs to be done for that. Zoran - 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=120709bid=263057dat=121642 ___ naviserver-devel mailing list naviserver-devel@lists.sourceforge.net https://lists.sourceforge.net/lists/listinfo/naviserver-devel -- Vlad Seryakov 571 262-8608 office [EMAIL PROTECTED] http://www.crystalballinc.com/vlad/
Re: [naviserver-devel] Example doctools manpage for C API ?
On 13.11.2006, at 18:25, Vlad Seryakov wrote: But why our current template will not work for C API? It can describe functions and arguments same way? It can, this is no problem. You will get a page-per-api-call. Under man pages it is common to have one man page describing many related api calls. It is this that does not work (yet) in doctools. Zoran
Re: [naviserver-devel] Example doctools manpage for C API ?
On 11/13/06, Zoran Vasiljevic [EMAIL PROTECTED] wrote: On 13.11.2006, at 18:25, Vlad Seryakov wrote: But why our current template will not work for C API? It can describe functions and arguments same way? It can, this is no problem. You will get a page-per-api-call. Under man pages it is common to have one man page describing many related api calls. It is this that does not work (yet) in doctools. Should I use 'fun' for C instead of 'cmd'? What's the deal with 'cmd_def' and 'arg_def' rather than 'cmd' and 'arg'? What's an i/o-mode? in/out? How do I document a structure? http://tcllib.sourceforge.net/doc/doctools_fmt.html
Re: [naviserver-devel] Example doctools manpage for C API ?
On 13.11.2006, at 19:12, Stephen Deasey wrote: Should I use 'fun' for C instead of 'cmd'? I think this is ok. What's the deal with 'cmd_def' and 'arg_def' rather than 'cmd' and 'arg'? The former are used in list definitions (list_begin/list_end) What's an i/o-mode? in/out? Yes. Input or output argument. I guess this is ment to be defined for function arguments that pass the value and at the same time hold the return value(s). How do I document a structure? He... a good question I do not know.
