Geometry: testing doxygen and quickbook integration with /// style comments and formatting of varios elements of synopsis.

[SVN r59851]

doc/quickbook/Jamfile.v2

@@ -37,7 +37,7 @@ run_doxygen access_reference
   :
     [ glob $(here)/../../../../boost/geometry/core/access.hpp ]
   :
-    "Access Reference"
+    "Access"
   ;
 
 xml geometry

include/boost/geometry/core/access.hpp

@@ -9,30 +9,29 @@
 #ifndef BOOST_GEOMETRY_CORE_ACCESS_HPP
 #define BOOST_GEOMETRY_CORE_ACCESS_HPP
 
-
+/// @defgroup access access: get/set coordinate values, make objects, clear geometries, append point(s)
-
+/// @details There are many ways to edit geometries. It is possible to:
-/*!
+///
-\defgroup access access: get/set coordinate values, make objects, clear geometries, append point(s)
+/// @li use the geometries themselves, so access point.x(). This is not done
-\details There are many ways to edit geometries. It is possible to:
+/// inside the library because it is agnostic to geometry type. However,
-- use the geometries themselves, so access point.x(). This is not done inside the library because it is agnostic
+/// library users can use this as it is intuitive.
- to geometry type. However, library users can use this as it is intuitive.
+/// @li use the standard library, so use .push_back(point) or use inserters.
-- use the standard library, so use .push_back(point) or use inserters. This is also avoided inside the library.
+/// This is also avoided inside the library. However, library users can use
-However, library users can use it if they are used to the standard library
+/// it if they are used to the standard library
-- use the functionality provided in this geometry library. These are the functions in this module.
+/// @li use the functionality provided in this geometry library. These are
-
+/// the functions in this module.
-The library provides the following functions to edit geometries:
+/// 
-- set to set one coordinate value
+/// The library provides the following functions to edit geometries:
-- assign to set two or more coordinate values
+/// @li set to set one coordinate value
-- make to construct and return geometries with specified coordinates.
+/// @li assign to set two or more coordinate values
-- append to append one or more points to a geometry
+/// @li make to construct and return geometries with specified coordinates.
-- clear to remove all points from a geometry
+/// @li append to append one or more points to a geometry
-
+/// @li clear to remove all points from a geometry
-For getting coordinates it is similar:
+/// 
-- get to get a coordinate value
+/// For getting coordinates it is similar:
-- or use the standard library
+/// @li get to get a coordinate value
-- or use the geometries themselves
+/// @li or use the standard library
-
+/// @li or use the geometries themselves
-*/
 
 #include <cstddef>
 
@@ -44,26 +43,25 @@ For getting coordinates it is similar:
 #include <boost/geometry/core/tag.hpp>
 
 
-namespace boost { namespace geometry
+namespace boost { namespace geometry {
-{
 
+/// Index of minimum corner of the box.
 const int min_corner = 0;
+
+/// Index of maximum corner of the box.
 const int max_corner = 1;
 
-namespace traits
+namespace traits {
-{
 
-/*!
+/// @brief Traits class which gives access (get,set) to points.
-\brief Traits class which gives access (get,set) to points
+/// @ingroup traits
-\ingroup traits
+/// @par Geometries:
-\par Geometries:
+///     @li point
-    - point
+/// @par Specializations should provide, per Dimension
-\par Specializations should provide, per Dimension
+///     @li static inline T get(const G&)
-    - static inline T get(const G&)
+///     @li static inline void set(G&, T const&)
-    - static inline void set(G&, T const&)
+/// @tparam Geometry geometry-type
-\tparam Geometry geometry-type
+/// @tparam Dimension dimension to access
-\tparam Dimension dimension to access
-*/
 template <typename Geometry, std::size_t Dimension>
 struct access {};