added new doxy group for decorators

emsec · May 9, 2024 · ebdba47 · ebdba47
1 parent fae3754
commit ebdba47
Show file tree

Hide file tree

Showing 5 changed files with 25 additions and 0 deletions.
diff --git a/include/hal_core/doxy_groups.h b/include/hal_core/doxy_groups.h
@@ -32,6 +32,11 @@
  * @ingroup core
  */
 
+/**
+ * @defgroup decorators Decorators
+ * @ingroup core
+ */
+
 /**
  * @defgroup pins Pins
  * @ingroup core

diff --git a/include/hal_core/netlist/decorators/boolean_function_decorator.h b/include/hal_core/netlist/decorators/boolean_function_decorator.h
@@ -33,6 +33,11 @@
 
 namespace hal
 {
+    /**
+     * A Boolean function decorator that provides functionality to operate on the associated Boolean function.
+     *
+     * @ingroup decorators
+     */
     class NETLIST_API BooleanFunctionDecorator
     {
     public:

diff --git a/include/hal_core/netlist/decorators/boolean_function_net_decorator.h b/include/hal_core/netlist/decorators/boolean_function_net_decorator.h
@@ -31,6 +31,11 @@
 
 namespace hal
 {
+    /**
+     * A net decorator that provides functionality to translate between nets and Boolean function variables.
+     *
+     * @ingroup decorators
+     */
     class NETLIST_API BooleanFunctionNetDecorator
     {
     public:

diff --git a/include/hal_core/netlist/decorators/netlist_modification_decorator.h b/include/hal_core/netlist/decorators/netlist_modification_decorator.h
@@ -32,6 +32,11 @@
 
 namespace hal
 {
+    /**
+     * A netlist decorator that provides functionality to modify the associated netlist.
+     *
+     * @ingroup decorators
+     */
     class NETLIST_API NetlistModificationDecorator
     {
     public:

diff --git a/include/hal_core/netlist/decorators/subgraph_netlist_decorator.h b/include/hal_core/netlist/decorators/subgraph_netlist_decorator.h
@@ -32,6 +32,11 @@
 
 namespace hal
 {
+    /**
+     * A netlist decorator that operates on an existing subgraph of the associated netlist to, e.g., copy the subgraph as a new netlist object or compute a Boolean function describing the subgraph.
+     *
+     * @ingroup decorators
+     */
     class NETLIST_API SubgraphNetlistDecorator
     {
     public: