Add initial version of doc of with_info classes

This commit is contained in:
Andreas Fabri 2021-01-19 16:43:17 +00:00
parent 6042946581
commit 41a3d1c448
3 changed files with 87 additions and 1 deletions

View File

@ -0,0 +1,50 @@
namespace CGAL {
/*!
\ingroup PkgSegmentDelaunayGraph2Ref
The class `Segment_Delaunay_graph_storage_site_with_info_2` is a model for the concept
`SegmentDelaunayGraphStorageSite_2`.
\tparam STraits must be a model of the `SegmentDelaunayGraphStorageTraits_2` concept.
\tparam Base must be a model of `SegmentDelaunayGraphStorageSite_2`
\cgalModels `SegmentDelaunayGraphStorageSite_2`
\sa `CGAL::Segment_Delaunay_graph_site_2<K>`
*/
template< typename STraits, typename Info_, typename Base >
class Segment_Delaunay_graph_storage_site_with_info_2 : public Base {
public:
/// \name Types
/// The class
/// @{
typedef STraits Storage_traits;
/*!
*/
typedef Info_ Info;
typedef typename Storage_traits::Geom_traits Geom_traits;
typedef typename Geom_traits::Site_2 Site_2;
typedef typename Storage_traits::Point_handle Point_handle;
struct Has_info_tag {};
/// @}
/*!
*/
const Info& info() const;
/*!
*/
void set_info(const Info&) const;
/*!
*/
bool info_has_been_set() const;
}; /* end Segment_Delaunay_graph_storage_site_with_info_2 */
} /* end namespace CGAL */

View File

@ -0,0 +1,35 @@
namespace CGAL {
/*!
\ingroup PkgSegmentDelaunayGraph2Ref
The class `Segment_Delaunay_graph_storage_traits_with_info_2` provides a model for the
`SegmentDelaunayGraphStorageTraits_2` concept.
\tparam Gt must be a model of the concept `SegmentDelaunayGraphTraits_2`.
\cgalModels `SegmentDelaunayGraphStorageTraits_2`
\sa `CGAL::`Segment_Delaunay_graph_storage_site_with_info_2`
*/
template<class Gt, class Info, class Converter, class Merger>
class Segment_Delaunay_graph_storage_traits_with_info_2
: public Segment_Delaunay_graph_storage_traits_2<Gt>
{
public:
/*!
*/
typedef Info_ Info;
typedef Converter Convert_info;
typedef Merger Merge_info;
typedef typename Base::Geom_traits Geom_traits;
typedef
Segment_Delaunay_graph_storage_site_with_info_2<Self,
Info,
Base_storage_site_2> Storage_site_2;
};
} //namespace CGAL

View File

@ -56,7 +56,9 @@ the class
- `CGAL::Segment_Delaunay_graph_2<Gt,St,DS>`
- `CGAL::Segment_Delaunay_graph_site_2<K>`
- `CGAL::Segment_Delaunay_graph_storage_site_2<Gt>`
- `CGAL::Segment_Delaunay_graph_storage_site_with_info_2<St,I,B>`
- `CGAL::Segment_Delaunay_graph_storage_traits_2<Gt>`
- `CGAL::Segment_Delaunay_graph_storage_traits_with_info_2<Gt,I,C,M>`
- `CGAL::Segment_Delaunay_graph_vertex_base_2<St,Vb>`
- `CGAL::Segment_Delaunay_graph_face_base_2<Gt,Fb>`
- `CGAL::Segment_Delaunay_graph_traits_2<K,MTag>`
@ -67,4 +69,3 @@ the class
- `CGAL::Segment_Delaunay_graph_hierarchy_vertex_base_2<Vbb>`
*/