From a1482a2b5820c9b2e884a559cc35ca744561456c Mon Sep 17 00:00:00 2001
From: Wenqing Wang <wenqing.wang@ufz.de>
Date: Fri, 25 Nov 2016 13:19:05 +0100
Subject: [PATCH] [Curve] Corrected the documentation for doxygen and added
documentation for keywords
---
Documentation/ProjectFile/curve/i_curve.md | 5 +++++
Documentation/ProjectFile/curve/t_coords.md | 1 +
Documentation/ProjectFile/curve/t_values.md | 1 +
MathLib/Curve/CreatePiecewiseLinearCurve.h | 2 +-
4 files changed, 8 insertions(+), 1 deletion(-)
create mode 100644 Documentation/ProjectFile/curve/i_curve.md
create mode 100644 Documentation/ProjectFile/curve/t_coords.md
create mode 100644 Documentation/ProjectFile/curve/t_values.md
diff --git a/Documentation/ProjectFile/curve/i_curve.md b/Documentation/ProjectFile/curve/i_curve.md
new file mode 100644
index 00000000000..d84424ab126
--- /dev/null
+++ b/Documentation/ProjectFile/curve/i_curve.md
@@ -0,0 +1,5 @@
+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.
diff --git a/Documentation/ProjectFile/curve/t_coords.md b/Documentation/ProjectFile/curve/t_coords.md
new file mode 100644
index 00000000000..933b7b48afc
--- /dev/null
+++ b/Documentation/ProjectFile/curve/t_coords.md
@@ -0,0 +1 @@
+Coordinates at which the curve's values are given.
diff --git a/Documentation/ProjectFile/curve/t_values.md b/Documentation/ProjectFile/curve/t_values.md
new file mode 100644
index 00000000000..54414177453
--- /dev/null
+++ b/Documentation/ProjectFile/curve/t_values.md
@@ -0,0 +1 @@
+Values of the curve at the given coordinates.
diff --git a/MathLib/Curve/CreatePiecewiseLinearCurve.h b/MathLib/Curve/CreatePiecewiseLinearCurve.h
index 9ad5273c3f3..1dbcccbf84a 100644
--- a/MathLib/Curve/CreatePiecewiseLinearCurve.h
+++ b/MathLib/Curve/CreatePiecewiseLinearCurve.h
@@ -23,7 +23,7 @@ class ConfigTree;
namespace MathLib
{
/// Create a curve
-/// \param config ConfigTree object has a tag of '<curve>'
+/// \param config ConfigTree object has a tag of `<curve>`
template <typename CurveType>
std::unique_ptr<CurveType> createPiecewiseLinearCurve(
BaseLib::ConfigTree const& config);
--
GitLab