Re: [q-lang-users] Documentation

[Albert G. <Dr....@t-...>]

Eddie Rucker wrote:
> Hope you are having a good vacation :) In the meantime, I forgot what we 
> wanted for the appendix for qdoc. Since you already have the stdlib and 
> clib should this include:

Hmm, I thought you just wanted to do an xref for the stuff that's
already there? Anyway, all the modules (core or addon) you mention
aren't documented in the manual yet, so clearly covering these in the
manual would be useful. But doing full documentation for all of these is
a herculean task.

For the beginning, it would be nice to have just a listing of the
available functions, with module names and maybe line numbers of
definitions, and a reference to the manual where applicable. Of course
this information would be most useful if it also included the core and
addon modules. Most of this information should be easily obtainable
using a script invoking completion_matches, whois and a search of the
manual index. The script could then be used to regenerate the crossref
whenever some part of the library changes so that it would always be
up-to-date.

> Curl
> GNU dbm
> ODBC
> Octave
> GGI
> ImageMagick
> Tcl/Tk
> IBM's Data Explorer
> 
> and should the appendix be titled "Module Reference."
> 
> Or was it suppose to include all of the add-ons:
> 
> Qt-Q,
> Qmidi,
> etc, ...

> I've gotten some things done on the Xref for which I would like to 
> include all of the functions for modules and add-ons. I'm thinking I 
> should stop and concentrate my effort on the Appendix first. What do you 
> think?

Again, I thought that we were talking about the xref, to make that an
appendix of the manual? But of course any other material for the manual
is welcome, too!

Albert

-- 
Dr. Albert Gr"af
Dept. of Music-Informatics, University of Mainz, Germany
Email:  Dr....@t-..., ag...@mu...
WWW:    http://www.musikinformatik.uni-mainz.de/ag