@@ -36,11 +36,11 @@ It is providing a step-by-step way of building an entity
3636\section sec_htw_helpers Helpers
3737
3838When writing entities you might use some macros which are very useful to write your class.
39- They are given also in the <a href="http://projects.laas.fr/gepetto/doc/stack-of-tasks/sot-core/master/doxygen-html">sot-core</a> package as well.
4039
4140\subsection subsec_howto_typedef Entity helpers
4241
4342The header <b>entity-helper.h</b> is defining a type called EntityClassName
43+
4444\section sec_howto_macros_helpers Macro helpers
4545
4646\subsection subsec_howto_macros_helpers Preprocessing macros for signals
@@ -95,17 +95,27 @@ The header <b>entity-helper.h</b> is defining a type called EntityClassName
9595
9696 </ul>
9797 <li>
98- </li>
98+ </li> Inner signals
99+ <ul>
99100 <li> <b> DECLARE_SIGNAL_INNER(signal_name,type)</b>
100101 Inner signal are signal that depend on a state of the entity and not on input signals.
101102 This macro declares an inner signal with the following pattern:
102103 \code
103104 m_signal_nameSINNER
104105 \endcode
105- </li>
106- <li> <b>DEFINE_SIGNAL_INNER_FUNCTION</b>
107- This macro
108- </li>
106+ It also creates a member function with the following pattern:
107+ \code
108+ type & EntityClassName::nameSINNER_function(signal_name)(type &, int)
109+ \endcode
110+ </li>
111+ <li> <b>DEFINE_SIGNAL_INNER_FUNCTION(signal_name,type)</b>
112+ This macro is used to implement the method related to signal_name. More precisely
113+ it provides the header of the member function(i.e. method) declaration.
114+ </li>
115+ <li><b>DECLARE_SIGNAL_INNER_FUNCTION(signal_name,type)</b>
116+ This macros declares the member function used to handle the access to this signal.
117+ </li>
118+ </ul>
109119</ul>
110120
111121*/
0 commit comments