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

[sampling] fix doxygen

parent ec422225
......@@ -18,12 +18,7 @@
*****************************************************************************/
/*!
* \file
* \brief Class to randomly generate disks in three-
* dimensional space. Generation is done on the
* basis of probability distribution functions
* provided among construction. The type of
* distribution function used in the sampler
* class can be defined by passing a traits class.
* \brief Class to randomly generate disks in three-dimensional space.
*/
#ifndef FRACKIT_DISK_SAMPLER_HH
#define FRACKIT_DISK_SAMPLER_HH
......
......@@ -18,13 +18,7 @@
*****************************************************************************/
/*!
* \file
* \brief Forward declaration of sampler classes used to
* randomly generate geometries. The sampler class
* is specialized for different geometries, and the
* required probability distribution functions are
* injected via corresponding traits classes.
* A default traits class should be provided by each
* sampler implementation.
* \brief Class to randomly generate geometries.
*/
#ifndef FRACKIT_GEOMETRY_SAMPLING_HH
#define FRACKIT_GEOMETRY_SAMPLING_HH
......@@ -34,7 +28,16 @@ namespace Frackit {
//! Forward declaration of the default traits
template<class Geometry> struct DefaultSamplerTraits;
//! Forward declaration of the sampler class
/*!
* \file
* \brief Forward declaration of sampler classes used to
* randomly generate geometries. The sampler class
* is specialized for different geometries, and the
* required probability distribution functions are
* injected via corresponding traits classes.
* A default traits class should be provided by each
* sampler implementation.
*/
template<class Geometry, class T = DefaultSamplerTraits<Geometry>>
struct GeometrySampler;
......
......@@ -18,11 +18,7 @@
*****************************************************************************/
/*!
* \file
* \brief Class to randomly generate points within geometries.
* The type of distribution functions to be used can be
* provided via a traits class, where a distribution for
* each coordinate of the geometry's local coordinate system
* is expected.
* \brief Class to randomly generate points, sampled on geometries.
*/
#ifndef FRACKIT_POINT_SAMPLING_HH
#define FRACKIT_POINT_SAMPLING_HH
......
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