[v3] doxygen updates

[v3] doxygen updates

[Benjamin Kosnik]

[-- Attachment #1: Type: text/plain, Size: 1786 bytes --]

Hi. 

This fixes a couple problems with the generated doxygen output. In
addition, it updates the generated doxygen config to 1.3.9.1, and
removes using dot in the default config. (This last bit is at the
longstanding request of the SC. Sadly, free software with equivalent
functionality of graphviz is still in progress. In the meantime, those
who want dot output will have to generate it themselves, which should
not be an undue hardship.)

The new output can be browsed here:

http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/index.html

I posted archives of generated html and man pages here:

ftp://gcc.gnu.org/pub/libstdc++/doxygen/libstdc++-html-USERS-20041105.tar.bz2
ftp://gcc.gnu.org/pub/libstdc++/doxygen/libstdc++-man-20041105.tar.bz2

tested x86/linux

2004-11-05  Benjamin Kosnik  <bkoz@redhat.com>

	PR libstdc++/17218
	PR libstdc++/17223
	* docs/doxygen/filter: Remove.
	* docs/doxygen/filter.sed: Remove.
	* docs/doxygen/mainpage.html: Add link to functions.
	* docs/doxygen/run_doxygen: Changes due to new source filtering.
	* docs/doxygen/user.cfg.in: Update to doxygen 1.3.9.1, tweak.
	* include/bits/allocator.h: Tweaks for doxygen.
	* include/bits/char_traits.h: Same.
	* include/bits/codecvt.h: Same.
	* include/bits/concurrence.h: Same.
	* include/bits/locale_facets.h: Same.
	* include/ext/array_allocator.h: Same.
	* include/ext/debug_allocator.h: Same.
	* include/ext/malloc_allocator.h: Same.
	* include/ext/mt_allocator.h: Same.
	* include/ext/new_allocator.h: Same.
	* include/ext/pool_allocator.h: Same.
	* include/ext/stdio_sync_filebuf.h: Same.
	* include/std/std_memory.h: Same.
	* include/tr1/array: Same.
	* include/tr1/tuple: Same.
	* config/locale/ieee_1003.1-2001/codecvt_specializations.h: Same.
	* config/os/gnu-linux/ctype_base.h: Same.


[-- Attachment #2: p.20041105.bz2 --]
[-- Type: application/x-bzip2, Size: 19176 bytes --]

Re: [v3] doxygen updates

[Joe Buck]

On Fri, Nov 05, 2004 at 01:56:19PM -0600, Benjamin Kosnik wrote:
> This fixes a couple problems with the generated doxygen output. In
> addition, it updates the generated doxygen config to 1.3.9.1, and
> removes using dot in the default config. (This last bit is at the
> longstanding request of the SC. Sadly, free software with equivalent
> functionality of graphviz is still in progress. In the meantime, those
> who want dot output will have to generate it themselves, which should
> not be an undue hardship.)

We now have a free VCG; I was hoping that this could be adapted to accept
dot-format input, and at one time mistakenly thought that it did.  I
thought that Mike DuPont was working on that, but I haven't heard from
him in a while.

Re: [v3] doxygen updates

[Phil Edwards]

> INPUT      = \
[...]
>            include/i686-pc-linux-gnu/bits

This seems wrong.  Granted that few if any people will be generating the docs
from scratch on any other build system :-),  but this still seems inflexible.


>   * docs/doxygen/filter: Remove.
>   * docs/doxygen/filter.sed: Remove.

Why?  This is what translated the uglified names in the source to more
readable names (without abbreviations and tons of underscores) in the output.
I looked for some other part that was now doing this, but can't find it.


-- 
America may be unique in being a country which has leapt
from barbarism to decadence without touching civilization.
  - John O'Hara

Re: [v3] doxygen updates

[Benjamin Kosnik]

>> INPUT      = \
>[...]
>>            include/i686-pc-linux-gnu/bits
>
>This seems wrong.  Granted that few if any people will be generating the docs
>from scratch on any other build system :-),  but this still seems inflexible.

Right.

This really needs host_alias substitutions.

>>   * docs/doxygen/filter: Remove.
>>   * docs/doxygen/filter.sed: Remove.
>
>Why?  This is what translated the uglified names in the source to more
>readable names (without abbreviations and tons of underscores) in the output.
>I looked for some other part that was now doing this, but can't find it.

The preprocessing support in doxygen itself is now better. We haven't
been using these filters for a while now.

-benjamin

[v3] doxygen updates

[Benjamin Kosnik]

[-- Attachment #1: Type: text/plain, Size: 107 bytes --]


Updates for the new files and types. Regenerated the on-line docs as
well.

tested x86_64/linux

-benjamin

[-- Attachment #2: p.20080714-1 --]
[-- Type: text/plain, Size: 11253 bytes --]

2008-07-15  Benjamin Kosnik  <bkoz@redhat.com>

	* doc/doxygen/user.cfg.in: Add complex, ratio,
	intializer_list.
	(PREDEFINED): Add _GLIBCXX_USE_C99_STDINT_TR1.
	* doc/doxygen/doxygroups.cc: Add std::chrono.
	* include/bits/unique_ptr.h (default_delete, unique_ptr): Add markup.
	* libsupc++/initializer_list (initializer_list): Same.
	* include/std/ratio: Same.
	* include/std/chrono: Same.
	* include/std/complex: Disambiguate file markup.

Index: doc/doxygen/user.cfg.in
===================================================================
--- doc/doxygen/user.cfg.in	(revision 137867)
+++ doc/doxygen/user.cfg.in	(working copy)
@@ -463,12 +463,14 @@
 INPUT                  = @srcdir@/libsupc++/cxxabi.h \
                          @srcdir@/libsupc++/cxxabi-forced.h \
                          @srcdir@/libsupc++/exception \
+                         @srcdir@/libsupc++/initializer_list \
                          @srcdir@/libsupc++/new \
                          @srcdir@/libsupc++/typeinfo \
                          include/algorithm \
                          include/array \
                          include/bitset \
                          include/chrono \
+                         include/complex \
                          include/condition_variable \
                          include/deque \
                          include/fstream \
@@ -1168,6 +1170,7 @@
 
 PREDEFINED             = __cplusplus \
 		         __GTHREADS \
+			 __GXX_EXPERIMENTAL_CXX0X__ \
                          "_GLIBCXX_STD_P= " \
                          "_GLIBCXX_STD_D= " \
                          _GLIBCXX_STD=std \
@@ -1183,16 +1186,18 @@
                          _GLIBCXX_DEPRECATED \
                          _GLIBCXX_USE_WCHAR_T \
                          _GLIBCXX_USE_LONG_LONG \
+			 _GLIBCXX_USE_C99_STDINT_TR1 \
                          __glibcxx_function_requires=// \
                          __glibcxx_class_requires=// \
                          __glibcxx_class_requires2=// \
                          __glibcxx_class_requires3=// \
                          __glibcxx_class_requires4=//
 
-# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then 
-# this tag can be used to specify a list of macro names that should be expanded. 
-# The macro definition that is found in the sources will be used. 
-# Use the PREDEFINED tag if you want to use a different macro definition.
+# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES
+# then this tag can be used to specify a list of macro names that
+# should be expanded.  The macro definition that is found in the
+# sources will be used.  Use the PREDEFINED tag if you want to use a
+# different macro definition.
 
 EXPAND_AS_DEFINED      = 
 
Index: doc/doxygen/doxygroups.cc
===================================================================
--- doc/doxygen/doxygroups.cc	(revision 137867)
+++ doc/doxygen/doxygroups.cc	(working copy)
@@ -28,12 +28,15 @@
 /** @namespace std::tr1::__detail
  *  @brief Implementation details not part of the namespace std::tr1 interface.
 */
-/** @namespace std::regex_constants
- *  @brief ISO C++ 0x entities sub namespace for regex.
+/** @namespace std::chrono
+ *  @brief ISO C++ 0x entities sub namespace for time and date.
 */
 /** @namespace std::placeholders
  *  @brief ISO C++ 0x entities sub namespace for functional.
 */
+/** @namespace std::regex_constants
+ *  @brief ISO C++ 0x entities sub namespace for regex.
+*/
 /** @namespace std::this_thread
  *  @brief ISO C++ 0x entities sub namespace for thread.
 */
Index: include/std/ratio
===================================================================
--- include/std/ratio	(revision 137867)
+++ include/std/ratio	(working copy)
@@ -165,6 +165,7 @@
   template<intmax_t _Num, intmax_t _Den>
     const intmax_t ratio<_Num, _Den>::den;
 
+  /// ratio_add
   template<typename _R1, typename _R2>
     struct ratio_add
     {
@@ -180,6 +181,7 @@
         __safe_multiply<_R1::den, (_R2::den / __gcd)>::value> type;
     };
 
+  /// ratio_subtract
   template<typename _R1, typename _R2>
     struct ratio_subtract
     {
@@ -188,6 +190,7 @@
         ratio<-_R2::num, _R2::den>>::type type;
     };
 
+  /// ratio_multiply
   template<typename _R1, typename _R2>
     struct ratio_multiply
     {
@@ -205,6 +208,7 @@
                         (_R2::den / __gcd1)>::value> type;
     };
 
+  /// ratio_divide
   template<typename _R1, typename _R2>
     struct ratio_divide
     {
@@ -215,11 +219,13 @@
         ratio<_R2::den, _R2::num>>::type type;
     };
 
+  /// ratio_equal
   template<typename _R1, typename _R2>
     struct ratio_equal
     : integral_constant<bool, _R1::num == _R2::num && _R1::den == _R2::den>
     { };
   
+  /// ratio_not_equal
   template<typename _R1, typename _R2>
     struct ratio_not_equal
     : integral_constant<bool, !ratio_equal<_R1, _R2>::value>
@@ -243,21 +249,25 @@
       __ratio_less_simple_impl<_R1, _R2>>::type
     { };
 
+  /// ratio_less
   template<typename _R1, typename _R2>
     struct ratio_less
     : __ratio_less_impl<_R1, _R2>::type
     { };
     
+  /// ratio_less_equal
   template<typename _R1, typename _R2>
     struct ratio_less_equal
     : integral_constant<bool, !ratio_less<_R2, _R1>::value>
     { };
   
+  /// ratio_greater
   template<typename _R1, typename _R2>
     struct ratio_greater
     : integral_constant<bool, ratio_less<_R2, _R1>::value>
     { };
 
+  /// ratio_greater_equal
   template<typename _R1, typename _R2>
     struct ratio_greater_equal
     : integral_constant<bool, !ratio_less<_R1, _R2>::value>
Index: include/std/chrono
===================================================================
--- include/std/chrono	(revision 137867)
+++ include/std/chrono	(working copy)
@@ -166,6 +166,7 @@
         { return numeric_limits<_Rep>::min(); }
       };
 
+    /// duration
     template<typename _Rep, typename _Period>
       struct duration
       {
@@ -430,61 +431,61 @@
     typedef duration<int,     ratio<  60>> minutes;
     typedef duration<int,     ratio<3600>> hours;
 
+    /// time_point
     template<typename _Clock, typename _Duration>
-    struct time_point
-    {
-      typedef _Clock                    clock;
-      typedef _Duration                 duration;
-      typedef typename duration::rep    rep;
-      typedef typename duration::period period;
-
-      time_point()
-      : __d(duration::zero())
-      { }
-
-      explicit time_point(const duration& __dur)
-      : __d(duration::zero() + __dur)
-      { }
-
-      // conversions
-      template<typename _Duration2>
-        time_point(const time_point<clock, _Duration2>& __t)
-        : __d(__t.time_since_epoch())
-        { }
-
-      // observer
-      duration
-      time_since_epoch() const
-      { return __d; }
-
-      // arithmetic
-      time_point&
-      operator+=(const duration& __dur)
+      struct time_point
       {
-        __d += __dur;
-        return *this;
-      }
+	typedef _Clock                    clock;
+	typedef _Duration                 duration;
+	typedef typename duration::rep    rep;
+	typedef typename duration::period period;
 
-      time_point&
-      operator-=(const duration& __dur)
-      {
-        __d -= __dur;
-        return *this;
-      }
+	time_point() : __d(duration::zero())
+	{ }
 
-      // special values
-      // TODO: These should be constexprs.
-      static const time_point
-      min()
-      { return time_point(duration::min()); }
+	explicit time_point(const duration& __dur) 
+	: __d(duration::zero() + __dur)
+	{ }
 
-      static const time_point
-      max()
-      { return time_point(duration::max()); }
+	// conversions
+	template<typename _Duration2>
+	  time_point(const time_point<clock, _Duration2>& __t)
+	  : __d(__t.time_since_epoch())
+	  { }
 
-    private:
-      duration __d;
-    };
+	// observer
+	duration
+	time_since_epoch() const
+	{ return __d; }
+	
+	// arithmetic
+	time_point&
+	operator+=(const duration& __dur)
+	{
+	  __d += __dur;
+	  return *this;
+	}
+	
+	time_point&
+	operator-=(const duration& __dur)
+	{
+	  __d -= __dur;
+	  return *this;
+	}
+	
+	// special values
+	// TODO: These should be constexprs.
+	static const time_point
+	min()
+	{ return time_point(duration::min()); }
+	
+	static const time_point
+	max()
+	{ return time_point(duration::max()); }
+	
+      private:
+	duration __d;
+      };
   
     template<typename _ToDuration, typename _Clock, typename _Duration>
       inline time_point<_Clock, _ToDuration> 
@@ -565,6 +566,7 @@
                  const time_point<_Clock, _Duration2>& __rhs)
       { return !(__lhs < __rhs); }
 
+    /// system_clock
     struct system_clock
     {
 #if defined(_GLIBCXX_USE_CLOCK_MONOTONIC) || \
Index: include/std/mutex
===================================================================
--- include/std/mutex	(revision 137867)
+++ include/std/mutex	(working copy)
@@ -120,7 +120,6 @@
 #endif
     }
 
-
     void
     lock()
     {
Index: include/std/complex
===================================================================
--- include/std/complex	(revision 137867)
+++ include/std/complex	(working copy)
@@ -29,7 +29,7 @@
 // invalidate any other reasons why the executable file might be covered by
 // the GNU General Public License.
 
-/** @file complex
+/** @file include/complex
  *  This is a Standard C++ Library header.
  */
 
Index: include/bits/unique_ptr.h
===================================================================
--- include/bits/unique_ptr.h	(revision 137867)
+++ include/bits/unique_ptr.h	(working copy)
@@ -40,13 +40,14 @@
 #endif
 
 #include <bits/c++config.h>
-#include <debug/debug.h>
+#include <debug/debug.h>1
 #include <type_traits>
 #include <utility>
 #include <tuple>
 
 _GLIBCXX_BEGIN_NAMESPACE(std)
 
+  /// Primary template, default_delete.
   template<typename _Tp> 
     struct default_delete
       {
@@ -66,6 +67,7 @@
 
   // _GLIBCXX_RESOLVE_LIB_DEFECTS
   // DR 740 - omit specialization for array objects with a compile time length
+  /// Specialization, default_delete.
   template<typename _Tp> 
     struct default_delete<_Tp[]>
     {
@@ -78,6 +80,7 @@
       }
     };
 
+  /// 20.6.11.2 unique_ptr for single objects.
   template <typename _Tp, typename _Tp_Deleter = default_delete<_Tp> > 
     class unique_ptr
     {
@@ -224,7 +227,7 @@
       __tuple_type _M_t;
   };
  
-  // 20.6.11.3 unique_ptr for array objects with a runtime length
+  /// 20.6.11.3 unique_ptr for array objects with a runtime length
   // [unique.ptr.runtime]
   // _GLIBCXX_RESOLVE_LIB_DEFECTS
   // DR 740 - omit specialization for array objects with a compile time length
Index: libsupc++/initializer_list
===================================================================
--- libsupc++/initializer_list	(revision 137867)
+++ libsupc++/initializer_list	(working copy)
@@ -28,6 +28,10 @@
 // invalidate any other reasons why the executable file might be covered by
 // the GNU General Public License.
 
+/** @file initializer_list
+ *  This is a Standard C++ Library header.
+ */
+
 #ifndef __CXX_INITIALIZER_LIST
 #define __CXX_INITIALIZER_LIST
 
@@ -39,6 +43,7 @@
 
 namespace std
 {
+  /// initializer_list
   template<class _E>
     class initializer_list
     {

[v3] doxygen updates

[Benjamin Kosnik]

Changes to support doxygen output for trunk and gcc-4_3-branch.
Generated output should be as on the gcc website. 

Notable changes include:
1) use doxygen default css style
2) add markup for some tr1 and C++0x bits missing (unordered_*,
type_traits, others)
3) simplified brief comments
4) downgrade to doxygen 1.5.1. There were issues with newer doxygen and
filenames, nested namespaces, etc.

This gives the generated docs for 4.3/trunk equivalent output as
for 4.2. I will wait a bit for the 4_3-branch check in. 

gcc
gcc-4_3-branch

tested x86_64/linux

-benjamin

Re: [v3] doxygen updates

[Benjamin Kosnik]

[-- Attachment #1: Type: text/plain, Size: 19 bytes --]

Patches attached.


[-- Attachment #2: p.20080326-1.bz2 --]
[-- Type: application/x-bzip, Size: 20590 bytes --]

[-- Attachment #3: p.20080326-1-4_3-branch.bz2 --]
[-- Type: application/x-bzip, Size: 19895 bytes --]

[v3] doxygen updates

[Benjamin Kosnik]

[-- Attachment #1: Type: text/plain, Size: 389 bytes --]


Updates to the "latest" doxygen and changes in style of generated
pages to more explicit qualification. More coherent namespace
documentation. Some of the css formatting for the class member
documentation seems off, which is next on the to-do list.

Newer graphviz has improved (cairo) output.

As here:
http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen

tested x86/linux

-benjamin

[-- Attachment #2: p.20061129.bz2 --]
[-- Type: application/x-bzip2, Size: 16754 bytes --]