This is the mail archive of the libstdc++@gcc.gnu.org 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]
Other format: [Raw text]

[libstdc++] Docs tweak


Some minor updates.  Even though I myself won't be doing the doxygen hooks
for any more SGI extensions for a long time, if ever, they should at least
show up in the output.


2002-07-02  Phil Edwards  <pme@gcc.gnu.org>

	* docs/html/configopts.html, docs/html/install.html:  Tweaks.
	* include/ext/algorithm, include/ext/hash_map, include/ext/hash_set,
	include/ext/iterator, include/ext/numeric, include/ext/rb_tree,
	include/ext/slist, include/ext/stl_rope.h:  Add doxygen hooks.


Index: docs/html/configopts.html
===================================================================
RCS file: /cvs/gcc/gcc/libstdc++-v3/docs/html/configopts.html,v
retrieving revision 1.21
diff -u -3 -p -r1.21 configopts.html
--- docs/html/configopts.html	9 Mar 2002 02:16:34 -0000	1.21
+++ docs/html/configopts.html	2 Jul 2002 06:16:04 -0000
@@ -26,7 +26,7 @@ options</a></h1>
 <p>Here are some of the non-obvious options to libstdc++'s configure.
    Keep in mind that
    <!-- This SECnn should be the "Choosing Package Options" section. -->
-   <a href="http://sources.redhat.com/autoconf/autoconf.html#SEC74";>they
+   <a href="http://www.gnu.org/manual/autoconf/html_node/Package-Options.html#Package%20Options";>they
    all have opposite forms as well</a>
    (enable/disable and with/without).  The defaults are for current
    development sources.
@@ -46,14 +46,13 @@ options</a></h1>
 
  <dt><code>--enable-debug  </code>
  <dd><p>The configure script will automatically detect the highest
-        level of optimization that the compiler in use can use
-        (certain versions of g++ will ICE if given the <code>-O2</code>
-        option, but this is fixed in later versions of the compiler).
+        level of optimization that the compiler in use can use.
         This --enable flag will disable all optimizations and instruct
         the compiler to emit as much extra debugging information as it
-        can, for use inside GDB. Note this make command, executed in
+        can, for use inside GDB.  Note this make command, executed in
         the build directory, will do much the same thing, without the
-        configuration difference:<code>make CXXFLAGS='-g -O0' all</code>
+        configuration difference:
+        <code>make CXXFLAGS='-g -O0' all</code>
      </p>
 
  <dt><code>--enable-cstdio  </code>
Index: docs/html/install.html
===================================================================
RCS file: /cvs/gcc/gcc/libstdc++-v3/docs/html/install.html,v
retrieving revision 1.15
diff -u -3 -p -r1.15 install.html
--- docs/html/install.html	13 May 2002 14:24:33 -0000	1.15
+++ docs/html/install.html	2 Jul 2002 06:16:04 -0000
@@ -73,7 +73,7 @@
       with C++ exception handling related to this change in
       libstdc++-v3).  The version of these tools should be
       <code>2.10.90</code>, or later, and you can get snapshots (as
-      well as releases) of binutils 
+      well as releases) of binutils
       <a href="ftp://sources.redhat.com/pub/binutils";>here</a>. The
       configure process will automatically detect and use these
       features if the underlying support is present.
@@ -87,7 +87,7 @@
       configure process will automatically detect and use these
       features if the underlying support is present.
    </p>
- 
+
     <p>Finally, a few system-specific requirements:
       <dl>
         <dt> linux
@@ -103,22 +103,22 @@
         named locale tests. If this isn't an issue, don't worry about
         it. If named locales are needed, the underlying locale
         information must be installed. Note that rebuilding libstdc++
-        after locales are installed is not necessary. 
-	
-	<p> To install
+        after locales are installed is not necessary.
+
+        <p> To install
         support for locales, do only one of the following: </p>
         <p>
- 	  <li> install all locales
-	  <p> <code> export LC_ALL=C </code> </p>
-	  <p> <code> rpm -e glibc-common --nodeps </code> </p>
-	  <p> <code> rpm -i --define "_install_langs all" 
-	  glibc-common-2.2.5-34.i386.rpm </code> </p>
-	  </li> 
-	  <li> install just the necessary locales
-	  <p> <code> localedef -i de_DE -f ISO-8859-1 de_DE </code> </p>
-	  </li> 
+          <li> install all locales
+          <p> <code> export LC_ALL=C </code> </p>
+          <p> <code> rpm -e glibc-common --nodeps </code> </p>
+          <p> <code> rpm -i --define "_install_langs all"
+          glibc-common-2.2.5-34.i386.rpm </code> </p>
+          </li>
+          <li> install just the necessary locales
+          <p> <code> localedef -i de_DE -f ISO-8859-1 de_DE </code> </p>
+          </li>
         </p>
-	</dd>
+        </dd>
       </dt>
     </dl>
    </p>
@@ -131,7 +131,7 @@
       <ul>
          <li><em>gccsrcdir</em>:  The directory holding the source of the
                  compiler.  It should have several subdirectories like
-                 <em>gccsrcdir</em>/libio and <em>gccsrcdir</em>/gcc.
+                 <em>gccsrcdir</em>/libiberty and <em>gccsrcdir</em>/gcc.
          <li><em>libsrcdir</em>:  The directory holding the source of the
                  C++ library.
          <li><em>gccbuilddir</em>:  The build directory for the compiler
@@ -216,7 +216,7 @@
    <h3>[re]building only libstdc++</h3>
    <p>To rebuild just libstdc++, use:
       <pre>
-   make all-target-<em>libstdc++-v3</em></pre>
+   make all-target-libstdc++-v3</pre>
       This will configure and build the C++ library in the
       <em>gccbuilddir/cpu-vendor-os/</em>libstdc++ directory.
    </p>
@@ -232,7 +232,7 @@
    <p>You're done.  Now install the rebuilt pieces with
       <pre>
    make install</pre>
-      or 
+      or
       <pre>
    make install-gcc
    make install-target-libstdc++-v3</pre>
Index: include/ext/algorithm
===================================================================
RCS file: /cvs/gcc/gcc/libstdc++-v3/include/ext/algorithm,v
retrieving revision 1.5
diff -u -3 -p -r1.5 algorithm
--- include/ext/algorithm	28 Jan 2002 22:13:09 -0000	1.5
+++ include/ext/algorithm	2 Jul 2002 06:16:04 -0000
@@ -247,6 +247,11 @@ namespace __gnu_cxx
 
   // random_sample and random_sample_n (extensions, not part of the standard).
 
+  /**
+   *  This is an SGI extension.
+   *  @ingroup SGIextensions
+   *  @doctodo
+  */
   template<typename _ForwardIter, typename _OutputIter, typename _Distance>
     _OutputIter
     random_sample_n(_ForwardIter __first, _ForwardIter __last,
@@ -273,6 +278,11 @@ namespace __gnu_cxx
       return __out;
     }
 
+  /**
+   *  This is an SGI extension.
+   *  @ingroup SGIextensions
+   *  @doctodo
+  */
   template<typename _ForwardIter, typename _OutputIter, typename _Distance,
 	   typename _RandomNumberGenerator>
     _OutputIter
@@ -353,6 +363,11 @@ namespace __gnu_cxx
       return __out + __m;
     }
 
+  /**
+   *  This is an SGI extension.
+   *  @ingroup SGIextensions
+   *  @doctodo
+  */
   template<typename _InputIter, typename _RandomAccessIter>
     inline _RandomAccessIter
     random_sample(_InputIter __first, _InputIter __last,
@@ -367,6 +382,11 @@ namespace __gnu_cxx
 			     __out_first, __out_last - __out_first);
     }
 
+  /**
+   *  This is an SGI extension.
+   *  @ingroup SGIextensions
+   *  @doctodo
+  */
   template<typename _InputIter, typename _RandomAccessIter, 
 	   typename _RandomNumberGenerator>
     inline _RandomAccessIter
@@ -418,6 +438,11 @@ namespace __gnu_cxx
       return true;
     }
 
+  /**
+   *  This is an SGI extension.
+   *  @ingroup SGIextensions
+   *  @doctodo
+  */
   template<typename _RandomAccessIter>
     inline bool
     is_heap(_RandomAccessIter __first, _RandomAccessIter __last)
@@ -430,6 +455,11 @@ namespace __gnu_cxx
       return __is_heap(__first, __last - __first);
     }
 
+  /**
+   *  This is an SGI extension.
+   *  @ingroup SGIextensions
+   *  @doctodo
+  */
   template<typename _RandomAccessIter, typename _StrictWeakOrdering>
     inline bool
     is_heap(_RandomAccessIter __first, _RandomAccessIter __last,
@@ -448,6 +478,11 @@ namespace __gnu_cxx
   // nondescending order.  This is an extension, not part of the C++
   // standard.
 
+  /**
+   *  This is an SGI extension.
+   *  @ingroup SGIextensions
+   *  @doctodo
+  */
   template<typename _ForwardIter>
     bool
     is_sorted(_ForwardIter __first, _ForwardIter __last)
@@ -469,6 +504,11 @@ namespace __gnu_cxx
       return true;
     }
 
+  /**
+   *  This is an SGI extension.
+   *  @ingroup SGIextensions
+   *  @doctodo
+  */
   template<typename _ForwardIter, typename _StrictWeakOrdering>
     bool
     is_sorted(_ForwardIter __first, _ForwardIter __last, _StrictWeakOrdering __comp)
Index: include/ext/hash_map
===================================================================
RCS file: /cvs/gcc/gcc/libstdc++-v3/include/ext/hash_map,v
retrieving revision 1.11
diff -u -3 -p -r1.11 hash_map
--- include/ext/hash_map	28 Jan 2002 22:13:09 -0000	1.11
+++ include/ext/hash_map	2 Jul 2002 06:16:04 -0000
@@ -83,7 +83,11 @@ class hash_map;
 template <class _Key, class _Tp, class _HashFn, class _EqKey, class _Alloc>
 inline bool operator==(const hash_map<_Key, _Tp, _HashFn, _EqKey, _Alloc>&,
                        const hash_map<_Key, _Tp, _HashFn, _EqKey, _Alloc>&);
-
+/**
+ *  This is an SGI extension.
+ *  @ingroup SGIextensions
+ *  @doctodo
+*/
 template <class _Key, class _Tp, class _HashFcn, class _EqualKey,
           class _Alloc>
 class hash_map
@@ -235,6 +239,11 @@ inline bool 
 operator==(const hash_multimap<_Key,_Tp,_HF,_EqKey,_Alloc>& __hm1,
            const hash_multimap<_Key,_Tp,_HF,_EqKey,_Alloc>& __hm2);
 
+/**
+ *  This is an SGI extension.
+ *  @ingroup SGIextensions
+ *  @doctodo
+*/
 template <class _Key, class _Tp, class _HashFcn, class _EqualKey, class _Alloc>
 class hash_multimap
 {
Index: include/ext/hash_set
===================================================================
RCS file: /cvs/gcc/gcc/libstdc++-v3/include/ext/hash_set,v
retrieving revision 1.11
diff -u -3 -p -r1.11 hash_set
--- include/ext/hash_set	28 Jan 2002 22:13:09 -0000	1.11
+++ include/ext/hash_set	2 Jul 2002 06:16:04 -0000
@@ -85,6 +85,11 @@ inline bool 
 operator==(const hash_set<_Value,_HashFcn,_EqualKey,_Alloc>& __hs1,
            const hash_set<_Value,_HashFcn,_EqualKey,_Alloc>& __hs2);
 
+/**
+ *  This is an SGI extension.
+ *  @ingroup SGIextensions
+ *  @doctodo
+*/
 template <class _Value, class _HashFcn, class _EqualKey, class _Alloc>
 class hash_set
 {
@@ -236,6 +241,11 @@ operator==(const hash_multiset<_Val,_Has
            const hash_multiset<_Val,_HashFcn,_EqualKey,_Alloc>& __hs2);
 
 
+/**
+ *  This is an SGI extension.
+ *  @ingroup SGIextensions
+ *  @doctodo
+*/
 template <class _Value, class _HashFcn, class _EqualKey, class _Alloc>
 class hash_multiset
 {
Index: include/ext/iterator
===================================================================
RCS file: /cvs/gcc/gcc/libstdc++-v3/include/ext/iterator,v
retrieving revision 1.4
diff -u -3 -p -r1.4 iterator
--- include/ext/iterator	28 Jan 2002 22:13:09 -0000	1.4
+++ include/ext/iterator	2 Jul 2002 06:16:04 -0000
@@ -93,6 +93,11 @@ namespace __gnu_cxx
       __n += __last - __first;
     }
 
+  /**
+   *  This is an SGI extension.
+   *  @ingroup SGIextensions
+   *  @doctodo
+  */
   template<typename _InputIterator, typename _Distance>
     inline void
     distance(_InputIterator __first, _InputIterator __last,
Index: include/ext/numeric
===================================================================
RCS file: /cvs/gcc/gcc/libstdc++-v3/include/ext/numeric,v
retrieving revision 1.3
diff -u -3 -p -r1.3 numeric
--- include/ext/numeric	28 Jan 2002 22:13:09 -0000	1.3
+++ include/ext/numeric	2 Jul 2002 06:16:04 -0000
@@ -105,11 +105,21 @@ namespace __gnu_cxx
   // Alias for the internal name __power.  Note that power is an extension,
   // not part of the C++ standard.
 
+  /**
+   *  This is an SGI extension.
+   *  @ingroup SGIextensions
+   *  @doctodo
+  */
   template<typename _Tp, typename _Integer, typename _MonoidOperation>
     inline _Tp
     power(_Tp __x, _Integer __n, _MonoidOperation __monoid_op)
     { return __power(__x, __n, __monoid_op); }
 
+  /**
+   *  This is an SGI extension.
+   *  @ingroup SGIextensions
+   *  @doctodo
+  */
   template<typename _Tp, typename _Integer>
     inline _Tp
     power(_Tp __x, _Integer __n)
@@ -117,6 +127,11 @@ namespace __gnu_cxx
 
   // iota is not part of the C++ standard.  It is an extension.
 
+  /**
+   *  This is an SGI extension.
+   *  @ingroup SGIextensions
+   *  @doctodo
+  */
   template<typename _ForwardIter, typename _Tp>
     void 
     iota(_ForwardIter __first, _ForwardIter __last, _Tp __value)
Index: include/ext/rb_tree
===================================================================
RCS file: /cvs/gcc/gcc/libstdc++-v3/include/ext/rb_tree,v
retrieving revision 1.2
diff -u -3 -p -r1.2 rb_tree
--- include/ext/rb_tree	28 Jan 2002 22:13:09 -0000	1.2
+++ include/ext/rb_tree	2 Jul 2002 06:16:04 -0000
@@ -73,6 +73,11 @@ using std::allocator;
 // Class rb_tree is not part of the C++ standard.  It is provided for
 // compatibility with the HP STL.
 
+/**
+ *  This is an SGI extension.
+ *  @ingroup SGIextensions
+ *  @doctodo
+*/
 template <class _Key, class _Value, class _KeyOfValue, class _Compare,
           class _Alloc = allocator<_Value> >
 struct rb_tree : public _Rb_tree<_Key, _Value, _KeyOfValue, _Compare, _Alloc>
Index: include/ext/slist
===================================================================
RCS file: /cvs/gcc/gcc/libstdc++-v3/include/ext/slist,v
retrieving revision 1.14
diff -u -3 -p -r1.14 slist
--- include/ext/slist	28 Jan 2002 22:13:09 -0000	1.14
+++ include/ext/slist	2 Jul 2002 06:16:04 -0000
@@ -295,6 +295,11 @@ _Slist_base<_Tp,_Alloc>::_M_erase_after(
   return __last_node;
 }
 
+/**
+ *  This is an SGI extension.
+ *  @ingroup SGIextensions
+ *  @doctodo
+*/
 template <class _Tp, class _Alloc = allocator<_Tp> >
 class slist : private _Slist_base<_Tp,_Alloc>
 {
Index: include/ext/stl_rope.h
===================================================================
RCS file: /cvs/gcc/gcc/libstdc++-v3/include/ext/stl_rope.h,v
retrieving revision 1.16
diff -u -3 -p -r1.16 stl_rope.h
--- include/ext/stl_rope.h	28 Jan 2002 22:13:09 -0000	1.16
+++ include/ext/stl_rope.h	2 Jul 2002 06:16:05 -0000
@@ -1238,6 +1238,11 @@ struct _Rope_base 
 };    
 
 
+/**
+ *  This is an SGI extension.
+ *  @ingroup SGIextensions
+ *  @doctodo
+*/
 template <class _CharT, class _Alloc>
 class rope : public _Rope_base<_CharT,_Alloc> {
     public:


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