This is the mail archive of the libstdc++@sourceware.cygnus.com mailing list for the libstdc++ project.


Index Nav: [Date Index] [Subject Index] [Author Index] [Thread Index]
Message Nav: [Date Prev] [Date Next] [Thread Prev] [Thread Next]

Re: man


> sorry for the ranting, but i hope its clearer now what i meant. if there is
> no work in this field at the moment, i'm interested in doing something about
> it as i find the situation most annoying. because i wasn't sure if someone

  i _love_ man pages!  (well, probably i'd love woman pages even more if
there were any...)  seriously, i find man pages, despite being such an
old concept, still one of the best documentation styles.  information is
presented in order of importance (NAME, SYNOPSIS, DESCRIPTION,...), and
once you get used to the structure, you're really fast in finding out
what you want.

  so, yes, do write man pages for the c++ library!  you'll probably
want to use the standard document as a reference.  i also find examples
very important for the documentation.  take a look at the dinkum c++
reference at

  http://www.dinkumware.com/htm_cpl/index.html

i think the library features should be accessible by their names, even
for members of template classes (same name implies equivalent
functionality in most cases, doesn't it?  in other cases, we would need
a qualified name, or list the differences of the function if they're
members of different classes in one man page...?)  also a man page for
each header would be nice.

  and, of course, i think nobody would mind if you release the
documentation under the GPL ;-)

> (which sections i consider important, mainly); if this list is the place to
> do it, please let me know. 

  IMHO, yes, why not?

greetings,
-gerhard

Index Nav: [Date Index] [Subject Index] [Author Index] [Thread Index]
Message Nav: [Date Prev] [Date Next] [Thread Prev] [Thread Next]