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

add some missing docu

parent 0d099868
......@@ -64,7 +64,7 @@ public:
//! pull up base class' constructor
using ParentType::ParentType;
//! \todo TODO doc me.
//! Return the name of this geometry
static std::string name() { return "Ellipse"; }
/*!
......
......@@ -407,11 +407,12 @@ public:
};
/*!
* \brief \todo TODO Doc me.
* \relates Vector
* \brief Creates a vector that is
* orthogonal to the provided vector.
* \relates Vector
*
* \param v a vector
* \returns a vector orthogonal to v
* \param v a vector
* \returns a vector orthogonal to v
*/
template<class ctype>
Vector<ctype, 3> makeOrthogonalVector(const Vector<ctype, 3>& v)
......
......@@ -120,7 +120,10 @@ public:
{}
/*!
* \brief \todo TODO Doc me.
* \brief Generate a random disk.
* \param pointSampler Point sampler class to
* randomly sample a point used
* as the center of the disk.
*/
template<class PointSampler>
Disk operator() (PointSampler& pointSampler)
......
......@@ -159,7 +159,7 @@ public:
{}
/*!
* \brief \todo TODO Doc me.
* \brief Sample a point from the distributions.
*/
Point operator() ()
{
......@@ -176,7 +176,7 @@ public:
};
/*!
* \brief \todo TODO Doc me.
* \brief Specialization of the sampler class for cylinders.
*/
template<class ctype, class T>
class GeometryPointSampler< Cylinder<ctype>, T >
......
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