songsenand
/
cgal
mirror of https://github.com/CGAL/cgal
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

inline the nested class Intersection_and_primitive_id in the documentation

This commit is contained in:
Sébastien Loriot 2013-07-24 17:06:35 +02:00
parent c2fc43a8df
commit ddda698034
2 changed files with 11 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
AABB_tree/doc/AABB_tree/Concepts/AABBTraits.h
View File

@ -58,13 +58,14 @@ typedef std::pair<Point_3, Primitive::Id> Point_and_primitive_id;
typedef std::pair<Object, Primitive::Id> Object_and_primitive_id;
/*! A nested class template providing as a pair the intersection result of a `Query` object
/*!
A nested class template providing as a pair the intersection result of a `Query` object
and a `Primitive::Datum`, together with the `Primitive::Id` of the primitive intersected.
The type of the pair is given by the nested type `Type`.
The type of the pair is `%Intersection_and_primitive_id<Query>::%Type`.
*/
template <typename Query>
struct Intersection_and_primitive_id{};
template <typename Query>
using Intersection_and_primitive_id = unspecified_type;
/// @}

7
AABB_tree/include/CGAL/AABB_tree.h
View File

@ -91,12 +91,17 @@ namespace CGAL {
typedef typename AABBTraits::Object_and_primitive_id Object_and_primitive_id;
/*!
An alias to AABBTraits::Interesction_and_primitive_id
An alias to `AABBTraits::Intersection_and_primitive_id<Query>`
*/
#ifdef DOXYGEN_RUNNING
template<typename Query>
using Intersection_and_primitive_id = AABBTraits::Intersection_and_primitive_id<Query>;
#else
template<typename Query>
struct Intersection_and_primitive_id {
typedef typename AABBTraits::template Intersection_and_primitive_id<Query>::Type Type;
};
#endif
///@}