Commit c3b6c5f7 authored by Dennis Gläser's avatar Dennis Gläser
Browse files

[doc][doxygen] add geometry group

parent ff3ebbab
......@@ -26,3 +26,8 @@
* geometric constraints (distance, intersection angle etc)
* between entities in entity networks.
*/
/*!
* \defgroup Geometry Geometry
* \brief Classes that define basic geometrical objects.
*/
......@@ -18,6 +18,7 @@
*****************************************************************************/
/*!
* \file
* \ingroup Geometry
* \brief Class that implements axis-aligned boxes in 3d space.
*/
#ifndef FRACKIT_GEOMETRY_BOX_HH
......@@ -35,6 +36,7 @@
namespace Frackit {
/*!
* \ingroup Geometry
* \brief Class that implements axis-aligned boxes in 3d space.
* \tparam CT The type used for coordinates
*/
......
......@@ -18,6 +18,7 @@
*****************************************************************************/
/*!
* \file
* \ingroup Geometry
* \brief Classes describing circles in n-dimensional space.
* \note For the moment, only circles in three-dimensional space are implemented.
*/
......@@ -37,6 +38,7 @@
namespace Frackit {
/*!
* \ingroup Geometry
* \brief Class describing a circle
* \tparam ctype The type used for coordinates.
* \tparam wd the space dimension.
......@@ -45,6 +47,7 @@ template<class ctype, int wd>
class Circle;
/*!
* \ingroup Geometry
* \brief Class describing a circle in 3d space.
* \tparam ctype The type used for coordinates
*/
......
......@@ -18,6 +18,7 @@
*****************************************************************************/
/*!
* \file
* \ingroup Geometry
* \brief Class that describes a cylinder in 3d space.
*/
#ifndef FRACKIT_GEOMETRY_CYLINDER_HH
......@@ -43,6 +44,7 @@ namespace Frackit {
template<class CT> class CylinderSurface;
/*!
* \ingroup Geometry
* \brief Class that describes a cylinder in 3d space.
* \tparam CT The type used for coordinates
*/
......
......@@ -18,6 +18,7 @@
*****************************************************************************/
/*!
* \file
* \ingroup Geometry
* \brief Class that describes the lateral
* surface of a cylinder in 3d space.
*/
......@@ -45,6 +46,7 @@ namespace Frackit {
template<class CT> class Cylinder;
/*!
* \ingroup Geometry
* \brief Class that describes the lateral
* surface of a cylinder in 3d space.
* \tparam CT The type used for coordinates
......
......@@ -18,6 +18,7 @@
*****************************************************************************/
/*!
* \file
* \ingroup Geometry
* \brief Class that implements directions (unit vectors).
*/
#ifndef FRACKIT_GEOMETRY_DIRECTION_HH
......@@ -34,6 +35,7 @@ namespace Frackit {
template<class CT, int wd> class Vector;
/*!
* \ingroup Geometry
* \brief Class representing directions (unit vectors).
* \tparam CT The type used for coordinates
* \tparam wd The dimension of the space
......@@ -42,6 +44,7 @@ template<class CT, int wd>
class Direction;
/*!
* \ingroup Geometry
* \brief Direction class implementation in 1d space.
* \tparam CT The type used for coordinates
*/
......@@ -93,6 +96,7 @@ private:
};
/*!
* \ingroup Geometry
* \brief Direction class implementation in 2d space.
* \tparam CT The type used for coordinates
*/
......@@ -148,6 +152,7 @@ private:
};
/*!
* \ingroup Geometry
* \brief Direction class implementation in 3d space.
* \tparam CT The type used for coordinates
*/
......@@ -207,6 +212,7 @@ private:
};
/*!
* \ingroup Geometry
* \brief Writes out a direction in 1d space.
* \relates Direction
*
......@@ -223,6 +229,7 @@ std::ostream& operator<< (std::ostream& s, const Direction<CT, 1>& d)
}
/*!
* \ingroup Geometry
* \brief Writes out a direction in 2d space.
* \relates Direction
*
......@@ -239,6 +246,7 @@ std::ostream& operator<< (std::ostream& s, const Direction<CT, 2>& d)
}
/*!
* \ingroup Geometry
* \brief Writes out a direction in 2d space.
* \relates Direction
*
......
......@@ -18,6 +18,7 @@
*****************************************************************************/
/*!
* \file
* \ingroup Geometry
* \brief Class that implements elliptical disks in 3d space.
*/
#ifndef FRACKIT_DISK_HH
......@@ -36,6 +37,7 @@
namespace Frackit {
/*!
* \ingroup Geometry
* \brief Class that implements elliptical disks in 3d space.
* \tparam CT The type used for coordinates
*/
......
......@@ -18,6 +18,7 @@
*****************************************************************************/
/*!
* \file
* \ingroup Geometry
* \brief Classes that implement ellipses in n-dimensional space.
*/
#ifndef FRACKIT_GEOMETRY_ELLIPSE_HH
......@@ -34,8 +35,9 @@
namespace Frackit {
/*!
* \brief Class that implements an ellipse in a
* space with the dimension worldDim.
* \ingroup Geometry
* \brief Class that implements an ellipse in
* n-dimensional space.
* \tparam CT The type used for coordinates
* \tparam wd The dimension of the space
*/
......@@ -43,6 +45,7 @@ template<class CT, int worldDim>
class Ellipse;
/*!
* \ingroup Geometry
* \brief Class that implements an ellipse in 3d space.
* \tparam CT The type used for coordinates
*/
......
......@@ -18,6 +18,7 @@
*****************************************************************************/
/*!
* \file
* \ingroup Geometry
* \brief Class that implements ellipse arcs in n-dimensional space.
*/
#ifndef FRACKIT_ELLIPSE_ARC_HH
......@@ -32,8 +33,9 @@
namespace Frackit {
/*!
* \brief Class that implements ellipse arcs in a
* space with the dimension worldDim.
* \ingroup Geometry
* \brief Class that implements ellipse arcs in
* n-dimensional space.
* \tparam CT The type used for coordinates
* \tparam wd The dimension of the space
*/
......@@ -41,6 +43,7 @@ template<class CT, int worldDim>
class EllipseArc;
/*!
* \ingroup Geometry
* \brief Class that implements ellipse arcs in 3 space.
* \tparam CT The type used for coordinates
*/
......
......@@ -18,6 +18,7 @@
*****************************************************************************/
/*!
* \file
* \ingroup Geometry
* \brief Base class for elliptical geometries.
*/
#ifndef FRACKIT_GEOMETRY_ELLIPTICAL_GEOMETRY_HH
......@@ -41,8 +42,9 @@ template<class CT, int wd> class Vector;
template<class CT, int wd> class Plane;
/*!
* \ingroup Geometry
* \brief Base class for elliptical geometries
* in a space with dimension worldDim.
* in n-dimensional space.
* \tparam CT The type used for coordinates
* \tparam wd The dimension of the space
*/
......@@ -50,6 +52,7 @@ template<class CT, int worldDim>
class EllipticalGeometry;
/*!
* \ingroup Geometry
* \brief Base class for ellipticcal geometries
* in three-dimensional space.
* \tparam CT The type used for coordinates
......
......@@ -18,6 +18,7 @@
*****************************************************************************/
/*!
* \file
* \ingroup Geometry
* \brief Abstract base class for geometries.
*/
#ifndef FRACKIT_GEOMETRY_HH
......@@ -28,6 +29,7 @@
namespace Frackit {
/*!
* \ingroup Geometry
* \brief Abstract base class for geometries.
*/
class Geometry
......@@ -39,6 +41,6 @@ public:
virtual std::string name() const = 0;
};
} // end namespace OpenFrack
} // end namespace Frackit
#endif // FRACKIT_DISK_HH
#endif // FRACKIT_GEOMETRY_HH
......@@ -18,6 +18,7 @@
*****************************************************************************/
/*!
* \file
* \ingroup Geometry
* \brief Classes that implements lines in n-dimensional space.
*/
#ifndef FRACKIT_GEOMETRY_LINE_HH
......@@ -39,6 +40,7 @@ template<class CT, int wd> class Point;
template<class CT, int wd> class Direction;
/*!
* \ingroup Geometry
* \brief Class that implements a line in
* a space with dimension wd.
* \tparam CT The type used for coordinates
......
......@@ -18,6 +18,7 @@
*****************************************************************************/
/*!
* \file
* \ingroup Geometry
* \brief Classes that implement planes in n-dimensional space.
*/
#ifndef FRACKIT_GEOMETRY_PLANE_HH
......@@ -38,6 +39,7 @@
namespace Frackit {
/*!
* \ingroup Geometry
* \brief Class that implements a plane
* in a coordinate space with dimension wd.
* \tparam CT The type used for coordinates
......@@ -47,6 +49,7 @@ template<class CT, int wd>
class Plane;
/*!
* \ingroup Geometry
* \brief Implementation of a plane in 3d space.
* \tparam CT The type used for coordinates
*/
......@@ -71,7 +74,7 @@ public:
//! Default constructor
Plane() = default;
/*!
* \brief Constructor
* \param p A point on the plane
......
......@@ -18,6 +18,7 @@
*****************************************************************************/
/*!
* \file
* \ingroup Geometry
* \brief Classes that implement points in n-dimensional space.
*/
#ifndef FRACKIT_GEOMETRY_POINT_HH
......@@ -39,6 +40,7 @@ namespace Frackit {
template<class CT, int wd> class Vector;
/*!
* \ingroup Geometry
* \brief Base class for Point implementations.
* \tparam Impl The actual vector class implementation
* \tparam CT The type used for coordinates
......@@ -111,6 +113,7 @@ private:
};
/*!
* \ingroup Geometry
* \brief Point class implementation.
* \tparam CT The type used for coordinates
* \tparam wd The dimension of the space
......@@ -119,6 +122,7 @@ template<class CT, int wd>
class Point;
/*!
* \ingroup Geometry
* \brief Point class implementation in 1d space.
*/
template<class CT>
......@@ -176,6 +180,7 @@ public:
};
/*!
* \ingroup Geometry
* \brief Point class implementation in 2d space.
*/
template<class CT>
......@@ -238,6 +243,7 @@ public:
};
/*!
* \ingroup Geometry
* \brief Point class implementation in 3d space.
*/
template<class CT>
......@@ -306,10 +312,10 @@ public:
/*!
* \brief Writes out a point in 1d space.
* \relates Vector
* \relates Point
*
* \param s std::ostream to write to
* \param v Vector to write
* \param p Point to write
*
* \returns the output stream (s)
*/
......@@ -322,10 +328,10 @@ std::ostream& operator<< (std::ostream& s, const Point<CT, 1>& p)
/*!
* \brief Writes out a point in 2d space.
* \relates Vector
* \relates Point
*
* \param s std::ostream to write to
* \param v Vector to write
* \param p Point to write
*
* \returns the output stream (s)
*/
......@@ -338,10 +344,10 @@ std::ostream& operator<< (std::ostream& s, const Point<CT, 2>& p)
/*!
* \brief Writes out a point in 3d space.
* \relates Vector
* \relates Point
*
* \param s std::ostream to write to
* \param v Vector to write
* \param p Point to write
*
* \returns the output stream (s)
*/
......
......@@ -18,6 +18,7 @@
*****************************************************************************/
/*!
* \file
* \ingroup Geometry
* \brief Classes that implement quadrilaterals in n-dimensional space.
*/
#ifndef FRACKIT_GEOMETRY_QUADRILATERAL_HH
......@@ -41,6 +42,7 @@
namespace Frackit {
/*!
* \ingroup Geometry
* \brief Class that implements a quadrilateral
* in a coordinate space with the dimension worldDim.
* \tparam CT The type used for coordinates
......@@ -50,6 +52,7 @@ template<class CT, int worldDim>
class Quadrilateral;
/*!
* \ingroup Geometry
* \brief Implementation of a quadrilateral in 3d space.
* \tparam CT The type used for coordinates
* \note This class describes planar quadrilaterals.
......
......@@ -18,6 +18,7 @@
*****************************************************************************/
/*!
* \file
* \ingroup Geometry
* \brief Class that describes a segment in n-dimensional space.
*/
#ifndef FRACKIT_GEOMETRY_SEGMENT_HH
......@@ -41,8 +42,9 @@ template<class CT, int wd> class Direction;
template<class CT, int wd> class Line;
/*!
* \brief Class that describes a segment in a
* coordinate space of dimension wd.
* \ingroup Geometry
* \brief Class that describes a segment in
* an n-dimensional space
* \tparam CT The type used for coordinates.
* \tparam wd The dimension of the coordinate space.
*/
......
......@@ -18,6 +18,7 @@
*****************************************************************************/
/*!
* \file
* \ingroup Geometry
* \brief Class that implements triangles in n-dimensional space.
*/
#ifndef FRACKIT_GEOMETRY_TRIANGLE_HH
......@@ -39,8 +40,9 @@
namespace Frackit {
/*!
* \ingroup Geometry
* \brief Class that implements triangles
* in a space of dimension worldDim
* in an n-dimensional space.
* \tparam CT The type used for coordinates
* \tparam worldDim The dimension of the coordinate space
*/
......@@ -48,6 +50,7 @@ template<class CT, int worldDim>
class Triangle;
/*!
* \ingroup Geometry
* \brief Class that implements triangles in 3d space.
* \tparam CT The type used for coordinates
*/
......
......@@ -18,6 +18,7 @@
*****************************************************************************/
/*!
* \file
* \ingroup Geometry
* \brief Classes that implement vectors in n-dimensional space.
*/
#ifndef FRACKIT_GEOMETRY_VECTOR_HH
......@@ -39,6 +40,7 @@
namespace Frackit {
/*!
* \ingroup Geometry
* \brief Class that implements vectors in
* a coordinate space of dimension wd
* \tparam CT The type used for coordinates
......@@ -133,6 +135,7 @@ namespace VectorImpl {
#endif // DOXYGEN_SHOULD_SKIP_THIS
/*!
* \ingroup Geometry
* \brief Base class of the dimension-specific Vector implementations.
* \tparam Impl The actual vector class implementation
* \tparam CT The type used for coordinates
......@@ -247,14 +250,7 @@ private:
};
/*!
* \brief Vector class implementation.
* \tparam CT The type used for coordinates
* \tparam wd The dimension of the space
*/
template<class CT, int wd>
class Vector;
/*!
* \ingroup Geometry
* \brief Vector class implementation in 1d space.
*/
template<class CT>
......@@ -302,6 +298,7 @@ public:
};
/*!
* \ingroup Geometry
* \brief Vector class implementation in 2d space.
*/
template<class CT>
......@@ -353,6 +350,7 @@ public:
};
/*!
* \ingroup Geometry
* \brief Vector class implementation for 3d space.
*/
template<class CT>
......@@ -425,6 +423,7 @@ Vector<ctype, 3> makeOrthogonalVector(const Vector<ctype, 3>& v)
}
/*!
* \ingroup Geometry
* \brief Writes out a vector in 1d space.
* \relates Vector
*
......@@ -441,6 +440,7 @@ std::ostream& operator<< (std::ostream& s, const Vector<CT, 1>& v)
}
/*!
* \ingroup Geometry
* \brief Writes out a vector in 2d space.
* \relates Vector
*
......@@ -457,6 +457,7 @@ std::ostream& operator<< (std::ostream& s, const Vector<CT, 2>& v)
}
/*!
* \ingroup Geometry
* \brief Writes out a vector in 2d space.
* \relates Vector
*
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment