From 55f922538be532fdb2d33d7190ca5f5a06cfbf44 Mon Sep 17 00:00:00 2001
From: Olivier Stasse <ostasse@laas.fr>
Date: Wed, 15 Jan 2020 13:37:10 +0100
Subject: [PATCH] [signal-ptr] Add comments and doc.
---
include/dynamic-graph/signal-ptr.h | 5 +++++
1 file changed, 5 insertions(+)
diff --git a/include/dynamic-graph/signal-ptr.h b/include/dynamic-graph/signal-ptr.h
index c5feb3f..5f2e8ac 100644
--- a/include/dynamic-graph/signal-ptr.h
+++ b/include/dynamic-graph/signal-ptr.h
@@ -20,6 +20,11 @@ namespace dynamicgraph {
/// In that sense, when plugged into, it acts as a "pointer" to the
/// input signal, hence the name. Operator -> is also overloaded and
/// can be used to access the pointed signal.
+///
+/// If the signal provided as a parameter of the plug operation
+/// cannot be casted in type T, but is compatible then the class
+/// holds a reference to an abstract object.
+///
template <class T, class Time>
class SignalPtr : public virtual Signal<T, Time> {
public:
--
GitLab