Include @group directives for Synopsis

dabrahams · dabrahams · commit 364826b3b382 · 2003-10-13T21:04:11.000Z
[SVN r20364]
diff --git a/include/boost/python/class.hpp b/include/boost/python/class.hpp
@@ -422,7 +422,7 @@ class class_ : public objects::class_base
     // (possibly not wrapped) base class of T, an lvalue argument of
     // type T will be required.
     //
-    // {
+    // @group make_fn {
     template <class F>
     object make_fn(F const& f)
     {
@@ -476,6 +476,7 @@ class class_ : public objects::class_base
     // These two overloads discriminate between def() as applied to a
     // generic visitor and everything else.
     //
+    // @group def_impl {
     template <class Helper, class LeafVisitor, class Visitor>
     inline void def_impl(
         char const* name
@@ -509,12 +510,14 @@ class class_ : public objects::class_base
 
         this->def_default(name, fn, helper, mpl::bool_<Helper::has_default_implementation>());
     }
+    // }
 
     //
     // These two overloads handle the definition of default
     // implementation overloads for virtual functions. The second one
     // handles the case where no default implementation was specified.
     //
+    // @group def_default {
     template <class Fn, class Helper>
     inline void def_default(
         char const* name
@@ -535,13 +538,15 @@ class class_ : public objects::class_base
     template <class Fn, class Helper>
     inline void def_default(char const*, Fn, Helper const&, mpl::bool_<false>)
     { }
+    // }
     
     //
     // These two overloads discriminate between def() as applied to
     // regular functions and def() as applied to the result of
     // BOOST_PYTHON_FUNCTION_OVERLOADS(). The final argument is used to
     // discriminate.
     //
+    // @group def_maybe_overloads {
     template <class OverloadsT, class SigT>
     void def_maybe_overloads(
         char const* name
@@ -571,6 +576,7 @@ class class_ : public objects::class_base
         );
 
     }
+    // }
 };
 
 
diff --git a/include/boost/python/detail/defaults_def.hpp b/include/boost/python/detail/defaults_def.hpp
@@ -43,7 +43,7 @@ namespace detail
   //
   // Dispatch to properly add f to namespace ns.
   //
-  // { define_stub_function helpers 
+  // @group define_stub_function helpers { 
   template <class Func, class CallPolicies, class NameSpaceT>
   static void name_space_def(
       NameSpaceT& name_space
@@ -122,7 +122,7 @@ namespace detail
   //                                  (see defaults_gen.hpp)
   //      5. char const* name:        doc string
   //
-  // {
+  // @group define_stub_function<N> {
   template <int N>
   struct define_stub_function {};
 
diff --git a/include/boost/python/detail/make_keyword_range_fn.hpp b/include/boost/python/detail/make_keyword_range_fn.hpp
@@ -22,7 +22,7 @@ namespace boost { namespace python { namespace detail {
 // arguments, because compile-time information about the number of
 // keywords is missing for all but the initial function definition.
 //
-// {
+// @group make_keyword_range_function {
 template <class F, class Policies>
 object make_keyword_range_function(
     F f
diff --git a/include/boost/python/make_constructor.hpp b/include/boost/python/make_constructor.hpp
@@ -138,12 +138,13 @@ namespace detail
       typedef int type;
   };
   
-  // { make_constructor_aux
   //
   // These helper functions for make_constructor (below) do the raw work
   // of constructing a Python object from some invokable entity. See
   // <boost/python/detail/caller.hpp> for more information about how
   // the Sig arguments is used.
+  //
+  // @group make_constructor_aux {
   template <class F, class CallPolicies, class Sig>
   object make_constructor_aux(
       F f                             // An object that can be invoked by detail::invoke()
@@ -195,10 +196,12 @@ namespace detail
   }
   // }
 
-
-  // { Helpers for make_constructor when called with 3 arguments.  These
-  //   dispatch functions are used to discriminate between the cases
-  //   when the 3rd argument is keywords or when it is a signature.
+  //
+  //   These dispatch functions are used to discriminate between the
+  //   cases when the 3rd argument is keywords or when it is a
+  //   signature.
+  //
+  //   @group Helpers for make_constructor when called with 3 arguments. {
   //
   template <class F, class CallPolicies, class Keywords>
   object make_constructor_dispatch(F f, CallPolicies const& policies, Keywords const& kw, mpl::true_)
@@ -224,9 +227,10 @@ namespace detail
   // }
 }
 
-// { These overloaded functions wrap a function or member function
+//   These overloaded functions wrap a function or member function
 //   pointer as a Python object, using optional CallPolicies,
-//   Keywords, and/or Signature.
+//   Keywords, and/or Signature. @group {
+//
 template <class F>
 object make_constructor(F f)
 {
diff --git a/include/boost/python/make_function.hpp b/include/boost/python/make_function.hpp
@@ -63,10 +63,11 @@ namespace detail
         , kw);
   }
 
-  // { Helpers for make_function when called with 3 arguments.  These
+  //   Helpers for make_function when called with 3 arguments.  These
   //   dispatch functions are used to discriminate between the cases
   //   when the 3rd argument is keywords or when it is a signature.
   //
+  // @group {
   template <class F, class CallPolicies, class Keywords>
   object make_function_dispatch(F f, CallPolicies const& policies, Keywords const& kw, mpl::true_)
   {
@@ -92,9 +93,11 @@ namespace detail
   
  }
 
-// { These overloaded functions wrap a function or member function
+//   These overloaded functions wrap a function or member function
 //   pointer as a Python object, using optional CallPolicies,
 //   Keywords, and/or Signature.
+//
+//   @group {
 template <class F>
 object make_function(F f)
 {
diff --git a/include/boost/python/pure_virtual.hpp b/include/boost/python/pure_virtual.hpp
@@ -18,7 +18,7 @@ namespace boost { namespace python {
 namespace detail
 {
   //
-  // { Helpers for pure_virtual_visitor, below.
+  // @group Helpers for pure_virtual_visitor. {
   //
   
   // Raises a Python RuntimeError reporting that a pure virtual
@@ -55,7 +55,7 @@ namespace detail
   }
 
   //
-  // } Helpers for pure_virtual_visitor
+  // } 
   //
 
   //
diff --git a/include/boost/python/signature.hpp b/include/boost/python/signature.hpp
@@ -49,7 +49,6 @@ struct most_derived
     >::type type;
 };
 
-// {
 //  The following macros generate expansions for::
 //
 //      template <class RT, class T0... class TN>
@@ -99,6 +98,8 @@ struct most_derived
 //  this" argument of member functions to Target, because the function
 //  may actually be a member of a base class which is not wrapped, and
 //  in that case conversion from python would fail.
+//
+// @group {
 
 #  define BOOST_PP_ITERATION_PARAMS_1                                   \
     (3, (0, BOOST_PYTHON_MAX_ARITY, <boost/python/signature.hpp>))

Original file line number	Diff line number	Diff line change
`@@ -63,10 +63,11 @@ namespace detail`
`63`	`63`	`, kw);`
`64`	`64`	`}`
`65`	`65`
`66`		`- // { Helpers for make_function when called with 3 arguments. These`
	`66`	`+ // Helpers for make_function when called with 3 arguments. These`
`67`	`67`	`// dispatch functions are used to discriminate between the cases`
`68`	`68`	`// when the 3rd argument is keywords or when it is a signature.`
`69`	`69`	`//`
	`70`	`+ // @group {`
`70`	`71`	`template <class F, class CallPolicies, class Keywords>`
`71`	`72`	`object make_function_dispatch(F f, CallPolicies const& policies, Keywords const& kw, mpl::true_)`
`72`	`73`	`{`
`@@ -92,9 +93,11 @@ namespace detail`
`92`	`93`
`93`	`94`	`}`
`94`	`95`
`95`		`-// { These overloaded functions wrap a function or member function`
	`96`	`+// These overloaded functions wrap a function or member function`
`96`	`97`	`// pointer as a Python object, using optional CallPolicies,`
`97`	`98`	`// Keywords, and/or Signature.`
	`99`	`+//`
	`100`	`+// @group {`
`98`	`101`	`template <class F>`
`99`	`102`	`object make_function(F f)`
`100`	`103`	`{`
Original file line number	Diff line number	Diff line change
`@@ -18,7 +18,7 @@ namespace boost { namespace python {`
`18`	`18`	`namespace detail`
`19`	`19`	`{`
`20`	`20`	`//`
`21`		`- // { Helpers for pure_virtual_visitor, below.`
	`21`	`+ // @group Helpers for pure_virtual_visitor. {`
`22`	`22`	`//`
`23`	`23`
`24`	`24`	`// Raises a Python RuntimeError reporting that a pure virtual`
`@@ -55,7 +55,7 @@ namespace detail`
`55`	`55`	`}`
`56`	`56`
`57`	`57`	`//`
`58`		`- // } Helpers for pure_virtual_visitor`
	`58`	`+ // }`
`59`	`59`	`//`
`60`	`60`
`61`	`61`	`//`