This is the mail archive of the
mailing list for the GCC project.
Re: documentation example for std::priority_queue
- From: Benjamin Kosnik <bkoz at redhat dot com>
- To: Jonathan Wakely <cow at compsoc dot man dot ac dot uk>
- Cc: TheDD at wanadoo dot fr, gcc-patches at gcc dot gnu dot org, libstdc++ at gcc dot gnu dot org
- Date: Wed, 3 Nov 2004 10:54:55 -0600
- Subject: Re: documentation example for std::priority_queue
- Organization: Red Hat / Chicago
- References: <000701c4bc1e$046f2490$1900a8c0@quake><20041103114108.GA42486@compsoc.man.ac.uk>
>That example was taken from the SGI docs which do a much better job
>than the current libstdc++ docs of giving examples and describing the
>STL components e.g. http://www.sgi.com/tech/stl/priority_queue.html
Yep. We shouldn't be adding examples to the source code, but to separate
documenation pages. (IMHO).
>IMHO if we're going to do more than just document the functional
>interfaces and the parameters they take we should aim for something as
>useful as the SGI docs - which is a big job that *might* be better left
>to dedicated STL user-guides and/or tutorials.
>I hope I haven't put you off contributing, as improvements to the
>documentation are much needed, but haphazardly adding just one example
>may not help much (others might disagree with me here).
Nope. I think that the current documentation can be improved, greatly.
I'm not sure how to start down that road, however. I do think that more
specific documentation, a la the debug mode docs or the current
allocator.html page is the way to go. I don't know how to get complete
coverage, however, or if that is a desired goal. (Or something we leave
to other texts.)