This is the mail archive of the
libstdc++@gcc.gnu.org
mailing list for the libstdc++ project.
[libstdc++] Tidy up master doxygen hook.
- From: Phil Edwards <pedwards at disaster dot jaj dot com>
- To: libstdc++ at gcc dot gnu dot org, gcc-patches at gcc dot gnu dot org
- Date: Fri, 28 Dec 2001 17:32:29 -0500
- Subject: [libstdc++] Tidy up master doxygen hook.
Doxygen will not consider an entity as documented unless the enclosing
namespace is documented. This means we need a hook for 'namespace std'
itself which will always be seen. At the beginning that meant we had to
put it in a header file somewhere, but we have a file for such things.
(Discovered while looking at the installed c++config.h and thinking, oi,
that's mighty odd.) Tested with 'make doxygen'.
2001-12-28 Phil Edwards <pme@gcc.gnu.org>
* include/bits/c++config: Move doxygen hook comment...
* docs/doxygen/doxygroups.cc: ...to here.
Index: docs/doxygen/doxygroups.cc
===================================================================
RCS file: /cvs/gcc/gcc/libstdc++-v3/docs/doxygen/doxygroups.cc,v
retrieving revision 1.4
diff -u -3 -p -r1.4 doxygroups.cc
--- doxygroups.cc 2001/12/19 21:57:39 1.4
+++ doxygroups.cc 2001/12/28 22:23:09
@@ -9,6 +9,12 @@
*/
// // // // // // // // // // // // // // // // // // // // // // // //
+/** @namespace std
+ * @brief Everything defined by the ISO C++ Standard is within namespace
+ * std.
+*/
+
+// // // // // // // // // // // // // // // // // // // // // // // //
/** @addtogroup SGIextensions STL extensions from SGI
Because libstdc++-v3 based its implementation of the STL subsections of
the library on the SGI 3.3 implementation, we inherited their extensions
Index: include/bits/c++config
===================================================================
RCS file: /cvs/gcc/gcc/libstdc++-v3/include/bits/c++config,v
retrieving revision 1.220
diff -u -3 -p -r1.220 c++config
--- c++config 2001/12/28 08:16:10 1.220
+++ c++config 2001/12/28 22:23:09
@@ -74,8 +74,4 @@
// The remainder of the prewritten config is mostly automatic; all the
// user hooks are listed above.
-/** @namespace std
- * @brief Everything defined by the ISO C++ Standard is within namespace std.
- */
-
// End of prewritten config; the discovered settings follow.