From 0e6ee86d9fb306414498356dc4410a85d2466b30 Mon Sep 17 00:00:00 2001
From: stasse <olivier.stasse@aist.go.jp>
Date: Tue, 6 Jul 2010 22:01:07 +0900
Subject: [PATCH] Adding documentation to cmdPlug.
---
include/dynamic-graph/interpreter-helper.h | 6 +++++-
1 file changed, 5 insertions(+), 1 deletion(-)
diff --git a/include/dynamic-graph/interpreter-helper.h b/include/dynamic-graph/interpreter-helper.h
index c041154..12d1086 100644
--- a/include/dynamic-graph/interpreter-helper.h
+++ b/include/dynamic-graph/interpreter-helper.h
@@ -91,8 +91,12 @@ class DYNAMICGRAPH_EXPORT InterpreterHelper
*/
void cmdDestroy( const std::string& objName,
std::ostream& os );
+
/*! \brief Connect two signals.
- Connect an input signal to an output one.
+ Connect the input signal obj1.signame1 to the output signal
+ obj2.signame2.
+ \param[in] obj1.signame1: the input signal.
+ \param[in] obj2.signame2: the output signal.
*/
void cmdPlug( const std::string& obj1, const std::string & signame1,
const std::string& obj2, const std::string & signame2,
--
GitLab