00181da3af
2002-02-01 Phil Edwards <pme@gcc.gnu.org> * docs/html/documentation.html: Update for 3.0.96. * docs/html/faq/index.html: Update for 3.0.96. * docs/html/faq/index.txt: Regenerated. * docs/doxygen/TODO: Update notes. * docs/html/17_intro/howto.html: Initial impl-specific listing. From-SVN: r49422
65 lines
2.7 KiB
Text
65 lines
2.7 KiB
Text
|
|
The approach I've been using for a given header is to recursively do each
|
|
of the "bits" headers which make up the standard header. So, e.g., while
|
|
there are four headers making up <algorithm>, three of them were already
|
|
documented in the course of doing other headers.
|
|
|
|
"Untouched" means I've deliberately skipped it for various reasons, or
|
|
haven't gotten to it yet. It /will/ be done (by somebody, eventually.)
|
|
|
|
|
|
Area Still needs to be doxygen-documented
|
|
-----------------------------------------------------------
|
|
|
|
c17 FINISHED (Nothing in Clause 17 "exists" in terms of code.)
|
|
c18 <limits>, Note A
|
|
c19 Note A
|
|
c20 Note A
|
|
c21 Untouched, Note B
|
|
c22 Untouched
|
|
c23 See doxygroups.cc and Note B.
|
|
c24 Untouched
|
|
c25 stl_algo.h (lots of stuff)
|
|
c26 <complex>, <valarray>, stl_numeric.h[26.4], Note A
|
|
c27 Untouched
|
|
|
|
backward/* Not scanned by doxygen. Should it be? Doubtful.
|
|
|
|
ext/* Some of the SGI algorithm/functional extensions.
|
|
All of rope/hashing/slist need docs.
|
|
|
|
__gnu_cxx Tricky. Right now ext/* are in this namespace.
|
|
|
|
[1.3.5] "implementation-defined behavior: behavior ... that depends
|
|
on the implementation *and that each implementation shall
|
|
document*." [my emphasis] Not all implementation choices
|
|
have been thus described; doxygen is not necessarily the
|
|
appropriate place for such descriptions, either. I suggest
|
|
adding this list to the Chapter 17 HOWTO.
|
|
|
|
-----------------------------------------------------------
|
|
|
|
NOTES:
|
|
|
|
A) So far I have not tried to document any of the <c*> headers. So entities
|
|
such as atexit() are undocumented throughout the library. Since we usually
|
|
do not have the C code (to which the doxygen comments would be attached),
|
|
this would need to be done in entirely separate files, a la doxygroups.cc.
|
|
|
|
B) Huge chunks of containers and strings are described in common "Tables"
|
|
in the standard. How to reproduce this information? I suspect we should
|
|
simply write some HTML tables (say, one <table> per Table per file), and
|
|
use doxygen hooks like @pre and @see to reference the tables. Then the
|
|
individual classes would do like the standard does, and only document
|
|
members for which additional info is available.
|
|
|
|
|
|
STYLE:
|
|
stl_deque.h, stl_pair.h, and stl_algobase.h have good examples of what I've
|
|
been using for class, namespace-scope, and function documentation, respectively.
|
|
These should serve as starting points. /Please/ maintain the inter-word and
|
|
inter-sentence spacing, as this might be generated and/or scanned in the
|
|
future.
|
|
|
|
|
|
vim:ts=4:et:
|