From 5e7ad66da00baeafaa88636d433cfcae55eaeb84 Mon Sep 17 00:00:00 2001
From: Olivier Stasse <ostasse@laas.fr>
Date: Tue, 16 Jul 2019 02:16:39 +0200
Subject: [PATCH] [doc] Add few doc to DumpReferencesObjects.hh
---
tests/DumpReferencesObjects.hh | 7 +++++++
1 file changed, 7 insertions(+)
diff --git a/tests/DumpReferencesObjects.hh b/tests/DumpReferencesObjects.hh
index d695c976..968784e1 100644
--- a/tests/DumpReferencesObjects.hh
+++ b/tests/DumpReferencesObjects.hh
@@ -25,10 +25,17 @@ namespace PatternGeneratorJRL
virtual void prepareFile(std::ofstream &aof,
std::string &prefix,
struct OneStep &anOneStep);
+ /// Fill-in tests
+ /// \param[in] aTestName: Prefix of the test (typically algorithm name)
+ /// \param[in] anOneStep: One iteration of the algorithm
+ /// \param[in] aCurrentConfiguration: A configuration vector in
+ /// RPY + motor angle format.
+ /// This method is a front end for fillInTestFormat1 and fillInTestFormat2
virtual void fillInTests(std::string &aTestName,
struct OneStep &anOneStep,
Eigen::VectorXd &aCurrentConfiguration);
+ ///
virtual void fillInTestsFormat1
(std::string &aTestName,
struct OneStep &anOneStep,
--
GitLab