Skip to content
Snippets Groups Projects
Commit a1482a2b authored by wenqing's avatar wenqing
Browse files

[Curve] Corrected the documentation for doxygen and added

 documentation for keywords
parent 8e43b0f3
No related branches found
No related tags found
No related merge requests found
Defines a single curve.
The curve is given by a set of coordinates (the arguments) and a set of values
at these coordinates. The values for any arguments between the given coordinates
are obtained via linear interpolation.
Coordinates at which the curve's values are given.
Values of the curve at the given coordinates.
...@@ -23,7 +23,7 @@ class ConfigTree; ...@@ -23,7 +23,7 @@ class ConfigTree;
namespace MathLib namespace MathLib
{ {
/// Create a curve /// Create a curve
/// \param config ConfigTree object has a tag of '<curve>' /// \param config ConfigTree object has a tag of `<curve>`
template <typename CurveType> template <typename CurveType>
std::unique_ptr<CurveType> createPiecewiseLinearCurve( std::unique_ptr<CurveType> createPiecewiseLinearCurve(
BaseLib::ConfigTree const& config); BaseLib::ConfigTree const& config);
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment