diff options
| author | pme <pme@138bc75d-0d04-0410-961f-82ee72b054a4> | 2002-02-08 07:34:54 +0000 |
|---|---|---|
| committer | pme <pme@138bc75d-0d04-0410-961f-82ee72b054a4> | 2002-02-08 07:34:54 +0000 |
| commit | 0c5561be86279282db50fa284802db486b992fe5 (patch) | |
| tree | 28abb2350209948faa6f676b8b229b1cddbe83b4 /libstdc++-v3/docs/doxygen/TODO | |
| parent | 8c8a860bf4dea3d679d6cbc57453b4050bba0bba (diff) | |
| download | ppe42-gcc-0c5561be86279282db50fa284802db486b992fe5.tar.gz ppe42-gcc-0c5561be86279282db50fa284802db486b992fe5.zip | |
2002-02-08 Phil Edwards <pme@gcc.gnu.org>
* docs/doxygen/TODO: Update.
* docs/doxygen/doxygroups.cc: Tweak __gnu_cxx description.
* docs/doxygen/mainpage.html: Add TODO list link.
* docs/doxygen/user.cfg.in: Add @doctodo hook.
* docs/doxygen/tables.html: New file, emoty structure only.
* include/bits/stl_iterator.h: Doxygenate just about everything.
* include/bits/stl_iterator_base_funcs.h: Ditto, clean up spaces.
* include/bits/stl_iterator_base_types.h: Add notes.
git-svn-id: svn+ssh://gcc.gnu.org/svn/gcc/trunk@49608 138bc75d-0d04-0410-961f-82ee72b054a4
Diffstat (limited to 'libstdc++-v3/docs/doxygen/TODO')
| -rw-r--r-- | libstdc++-v3/docs/doxygen/TODO | 13 |
1 files changed, 10 insertions, 3 deletions
diff --git a/libstdc++-v3/docs/doxygen/TODO b/libstdc++-v3/docs/doxygen/TODO index da2f25ab5e7..375cd5fc785 100644 --- a/libstdc++-v3/docs/doxygen/TODO +++ b/libstdc++-v3/docs/doxygen/TODO @@ -7,6 +7,13 @@ 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.) +If you document an area and need to skip (for whatever reason) a non-trivial +entity (i.e., one that should be documented), go ahead and add the comment +markup, and use the homegrown @doctodo tag. See include/bits/stl_iterator.h +for examples of this. Doing so will at least cause doxygen to consider the +entitiy as documented and include it in the output. It will also add the +entity to the generated TODO page. + Area Still needs to be doxygen-documented ----------------------------------------------------------- @@ -18,7 +25,8 @@ c20 Note A c21 Untouched, Note B c22 Untouched c23 See doxygroups.cc and Note B. -c24 Untouched +c24 stl_iterator.h (__normal_iterator, other small TODO bits) + stream iterators c25 stl_algo.h (lots of stuff) c26 <complex>, <valarray>, stl_numeric.h[26.4], Note A c27 Untouched @@ -40,8 +48,7 @@ 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 +in the standard. These are being pseudo-duplicated in tables.html. We can 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. |
