From ebdba4709fd71d9303c454fc5e2d0b27d7c849dc Mon Sep 17 00:00:00 2001
From: "julian.speith" <julian.speith@mpi-sp.org>
Date: Thu, 9 May 2024 11:46:50 +0200
Subject: [PATCH] added new doxy group for decorators

---
 include/hal_core/doxy_groups.h                               | 5 +++++
 .../hal_core/netlist/decorators/boolean_function_decorator.h | 5 +++++
 .../netlist/decorators/boolean_function_net_decorator.h      | 5 +++++
 .../netlist/decorators/netlist_modification_decorator.h      | 5 +++++
 .../hal_core/netlist/decorators/subgraph_netlist_decorator.h | 5 +++++
 5 files changed, 25 insertions(+)

diff --git a/include/hal_core/doxy_groups.h b/include/hal_core/doxy_groups.h
index e03a4da1747..514667f51bf 100644
--- 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
index 3b427c7057b..23aed4e88a6 100644
--- 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
index f0ca329953c..31db4785554 100644
--- 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
index ef9cb5df781..dca8e73b6b7 100644
--- 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
index 37704053d60..06729ad2328 100644
--- 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: