Skip to content
GitLab
Menu
Projects
Groups
Snippets
/
Help
Help
Support
Community forum
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in / Register
Toggle navigation
Menu
Open sidebar
tools
frackit
Commits
86ffd34b
Commit
86ffd34b
authored
Jan 18, 2020
by
Dennis Gläser
Browse files
add some missing docu
parent
0d099868
Changes
4
Hide whitespace changes
Inline
Side-by-side
frackit/geometry/ellipse.hh
View file @
86ffd34b
...
...
@@ -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"
;
}
/*!
...
...
frackit/geometry/vector.hh
View file @
86ffd34b
...
...
@@ -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
)
...
...
frackit/sampling/disksampler.hh
View file @
86ffd34b
...
...
@@ -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
)
...
...
frackit/sampling/pointsampling.hh
View file @
86ffd34b
...
...
@@ -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
>
...
...
Write
Preview
Supports
Markdown
0%
Try again
or
attach a new file
.
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment