Re: [q-lang-users] Documentation

[<ed...@ri...>]

=0D
Eddie Rucker wrote:=0D
> > Hope you are having a good vacation  :)  In the meantime, I forgot what=
 we =0D
> > wanted for the appendix for qdoc. Since you already have the stdlib and=
 =0D
> > clib should this include:=0D
=0D
Hmm, I thought you just wanted to do an xref for the stuff that's=0D
already there? Anyway, all the modules (core or addon) you mention=0D
aren't documented in the manual yet, so clearly covering these in the=0D
manual would be useful. But doing full documentation for all of these is=0D
a herculean task.=0D
=0D
For the beginning, it would be nice to have just a listing of the=0D
available functions, with module names and maybe line numbers of=0D
definitions, and a reference to the manual where applicable. Of course=0D
this information would be most useful if it also included the core and=0D
addon modules. Most of this information should be easily obtainable=0D
using a script invoking completion_matches, whois and a search of the=0D
manual index. The script could then be used to regenerate the crossref=0D
whenever some part of the library changes so that it would always be=0D
up-to-date.=0D
=0D
> > Curl=0D
> > GNU dbm=0D
> > ODBC=0D
> > Octave=0D
> > GGI=0D
> > ImageMagick=0D
> > Tcl/Tk=0D
> > IBM's Data Explorer=0D
> > =0D
> > and should the appendix be titled "Module Reference."=0D
> > =0D
> > Or was it suppose to include all of the add-ons:=0D
> > =0D
> > Qt-Q,=0D
> > Qmidi,=0D
> > etc, ...=0D
=0D
> > I've gotten some things done on the Xref for which I would like to =0D
> > include all of the functions for modules and add-ons. I'm thinking I =
=0D
> > should stop and concentrate my effort on the Appendix first. What do yo=
u =0D
> > think?=0D
=0D
Again, I thought that we were talking about the xref, to make that an=0D
appendix of the manual? But of course any other material for the manual=0D
is welcome, too!=0D
=0D
Albert=0D
=0D
-- Dr. Albert Gr"af Dept. of Music-Informatics, University of Mainz, German=
y=0D
Email: Dr....@t-..., ag...@mu... WWW:=0D
http://www.musikinformatik.uni-mainz.de/ag=0D
------------------------------------------------------------------------- T=
his=0D
SF.net email is sponsored by: Splunk Inc. Still grepping through log files =
to=0D
find problems? Stop. Now Search log events and configuration files using AJ=
AX and=0D
a browser. Download your FREE copy of Splunk now >> http://get.splunk.com/=
=0D
_______________________________________________ q-lang-users mailing list=
=0D
q-l...@li...=0D
https://lists.sourceforge.net/lists/listinfo/q-lang-users =0D