Skip to content

Commit b605074

Browse files
[doc] Add documentation on macros for the entities.
1 parent 196db94 commit b605074

File tree

1 file changed

+16
-1
lines changed

1 file changed

+16
-1
lines changed

doc/additionalDoc/extension.h

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,7 @@ It is providing a step-by-step way of building an entity
3535
3636
\section sec_htw_helpers Helpers
3737
38+
3839
When writing entities you might use some macros which are very useful to write your class.
3940
4041
\subsection subsec_howto_typedef Entity helpers
@@ -43,7 +44,21 @@ The header <b>entity-helper.h</b> is defining a type called EntityClassName
4344
4445
\section sec_howto_macros_helpers Macro helpers
4546
46-
\subsection subsec_howto_macros_helpers Preprocessing macros for signals
47+
\subsection subsec_howto_macros_helpers_ent Preprocessing macros for entities
48+
49+
<ul>
50+
<li> <b>DYNAMIC_GRAPH_ENTITY_DECL()</b>:
51+
This macro creates a method <b>getClassName()</b> which returns the class name.</li>
52+
This macro <b>should</b> be used in the declaration of the class.
53+
</li>
54+
<li> <b>DYNAMICGRAPH_FACTORY_ENTITY_PLUGIN(classtype,classname)</b>
55+
This macros creates the methods necessary to have a factory building the C++ class
56+
<b>classtype</b> from the string <b>classname</b>.
57+
This macro <b>should</b> be used in the implementation of the class.
58+
</li>
59+
</ul>
60+
61+
\subsection subsec_howto_macros_helpers_sig Preprocessing macros for signals
4762
4863
<ul>
4964
<li> Macro for input signals

0 commit comments

Comments
 (0)