From 46775a793ddfdd8c55f76c6919723ce481b6b8a1 Mon Sep 17 00:00:00 2001
From: JasonChmn <jason.chemin@hotmail.fr>
Date: Wed, 17 Apr 2019 15:58:16 +0200
Subject: [PATCH] Edit doc on bezier_polynom_conversion and curve_abc
---
include/curves/bezier_polynom_conversion.h | 6 +++---
include/curves/curve_abc.h | 20 ++++++++++----------
2 files changed, 13 insertions(+), 13 deletions(-)
diff --git a/include/curves/bezier_polynom_conversion.h b/include/curves/bezier_polynom_conversion.h
index 6829f98..47b83c6 100644
--- a/include/curves/bezier_polynom_conversion.h
+++ b/include/curves/bezier_polynom_conversion.h
@@ -50,9 +50,9 @@ Polynom from_bezier(const Bezier& curve)
return Polynom(coefficients,curve.min(),curve.max());
}
-///\brief Converts a polynom to a Bezier curve
-///\param polynom: the polynom to be converted from
-///\return the equivalent Bezier curve
+///\brief Converts a polynom to a Bezier curve.
+///\param polynom: the polynom to convert.
+///\return The equivalent Bezier curve.
/*template<typename Bezier, typename Polynom>
Bezier from_polynom(const Polynom& polynom)
{
diff --git a/include/curves/curve_abc.h b/include/curves/curve_abc.h
index a943eb8..55d45a5 100644
--- a/include/curves/curve_abc.h
+++ b/include/curves/curve_abc.h
@@ -18,9 +18,9 @@
namespace curves
{
-/// \struct curve_abc
-/// \brief Represents a curve of dimension Dim
-/// is Safe is false, no verification is made on the evaluation of the curve.
+/// \struct curve_abc.
+/// \brief Represents a curve of dimension Dim.
+/// If parameter Safe is false, no verification is made on the evaluation of the curve.
template<typename Time= double, typename Numeric=Time, std::size_t Dim=3, bool Safe=false
, typename Point= Eigen::Matrix<Numeric, Dim, 1> >
struct curve_abc : std::unary_function<Time, Point>
@@ -30,25 +30,25 @@ struct curve_abc : std::unary_function<Time, Point>
/* Constructors - destructors */
public:
- ///\brief Constructor
+ /// \brief Constructor.
curve_abc(){}
- ///\brief Destructor
+ /// \brief Destructor.
virtual ~curve_abc(){}
/* Constructors - destructors */
/*Operations*/
public:
/// \brief Evaluation of the cubic spline at time t.
- /// \param t : the time when to evaluate the spine
- /// \param return : the value x(t)
+ /// \param t : time when to evaluate the spine
+ /// \return Point corresponding on curve at time t.
virtual point_t operator()(const time_t t) const = 0;
/// \brief Evaluation of the derivative spline at time t.
- /// \param t : the time when to evaluate the spline
- /// \param order : order of the derivative
- /// \param return : the value x(t)
+ /// \param t : time when to evaluate the spline.
+ /// \param order : order of the derivative.
+ /// \return Point corresponding on curve at time t.
virtual point_t derivate(const time_t t, const std::size_t order) const = 0;
/*Operations*/
--
GitLab