hello,
is there somewhere an overview-document on the netstring-libraries
(nethtml, netchannels, and the many others)?
There are so much moudles, that it's not that easy to find
the things one looks for.
It seems a general problem in documentation of OCaml modules,
that the developers might think, it is enough to document
the interface.
Documenting the interface is necessary, and IMHO OCaml
here is superior to other languages, because with ocamldoc
it's easily done and because of the type system the things are
very clear.
But a huge number of modules without the right "entry point";
means a lot of work...
A good thing ( I don't know if there already is a tool like this or
if the INRIA is already developing such a thing) would be,
to have a hierarchical documentation of the types in use.
So, for example if one module needs as input the types of another
module, then this "hierarchy" should be documented in some way.
For example: one function has
val myfunc: string -> mytype
and another function (of a different module)
has type
val anotherfunc: mytype -> anothertype
and so on.
To find the first module, which takes a string (e.g. gfilename,
URL or something like that) which produces the values, other modules
are looking for, is not easy, if there are to many modules,
all documented seperately.
So, is at least for the net*-libs a hierarchical documentation,
that makes it easier to start with these modules?!
Or is there a tutorial?
A interface-reference documentation alone is not enough, IMHO.
TIA,
Oliver
.
