updated documentation

Author: SJulianS

include/hal_core/doxy_groups.h

@@ -33,10 +33,15 @@
  */
 
 /**
- * @defgroup pins Pins
+ * @defgroup decorators Decorators
  * @ingroup core
  */
 
+/**
+ * @defgroup pins Pins
+ * @ingroup netlist
+ */
+
 /**
  * @defgroup netlist_parser Netlist Parser
  * @ingroup netlist

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:

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:

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:

include/hal_core/netlist/decorators/netlist_traversal_decorator.h

@@ -31,6 +31,11 @@
 
 namespace hal
 {
+    /**
+     * A netlist decorator that provides functionality to traverse the associated netlist without making any modifications.
+     *
+     * @ingroup decorators
+     */
     class NETLIST_API NetlistTraversalDecorator
     {
     public:

include/hal_core/netlist/decorators/subgraph_netlist_decorator.h

@@ -33,6 +33,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:

src/python_bindings/bindings/boolean_function_decorator.cpp

@@ -4,7 +4,8 @@ namespace hal
 {
     void boolean_function_decorator_init(py::module& m)
     {
-        py::class_<BooleanFunctionDecorator> py_boolean_function_decorator(m, "BooleanFunctionDecorator", R"()");
+        py::class_<BooleanFunctionDecorator> py_boolean_function_decorator(
+            m, "BooleanFunctionDecorator", R"(A Boolean function decorator that provides functionality to operate on the associated Boolean function.)");
 
         py_boolean_function_decorator.def(py::init<const BooleanFunction&>(), py::arg("bf"), R"(
             Construct new BooleanFunctionDecorator object.

src/python_bindings/bindings/boolean_function_net_decorator.cpp

@@ -4,7 +4,8 @@ namespace hal
 {
     void boolean_function_net_decorator_init(py::module& m)
     {
-        py::class_<BooleanFunctionNetDecorator> py_boolean_function_net_decorator(m, "BooleanFunctionNetDecorator", R"()");
+        py::class_<BooleanFunctionNetDecorator> py_boolean_function_net_decorator(
+            m, "BooleanFunctionNetDecorator", R"(A net decorator that provides functionality to translate between nets and Boolean function variables.)");
 
         py_boolean_function_net_decorator.def(py::init<const Net&>(), py::arg("net"), R"(
             Construct new BooleanFunctionNetDecorator object.

src/python_bindings/bindings/netlist_modification_decorator.cpp

@@ -4,7 +4,8 @@ namespace hal
 {
     void netlist_modification_decorator_init(py::module& m)
     {
-        py::class_<NetlistModificationDecorator> py_netlist_modification_decorator(m, "NetlistModificationDecorator", R"()");
+        py::class_<NetlistModificationDecorator> py_netlist_modification_decorator(
+            m, "NetlistModificationDecorator", R"(A netlist decorator that provides functionality to modify the associated netlist.)");
 
         py_netlist_modification_decorator.def(py::init<Netlist&>(), py::arg("netlist"), R"(
             Construct new NetlistModificationDecorator object.

src/python_bindings/bindings/netlist_traversal_decorator.cpp

@@ -4,7 +4,8 @@ namespace hal
 {
     void netlist_traversal_decorator_init(py::module& m)
     {
-        py::class_<NetlistTraversalDecorator> py_netlist_traversal_decorator(m, "NetlistTraversalDecorator", R"()");
+        py::class_<NetlistTraversalDecorator> py_netlist_traversal_decorator(
+            m, "NetlistTraversalDecorator", R"(A netlist decorator that provides functionality to traverse the associated netlist without making any modifications.)");
 
         py_netlist_traversal_decorator.def(py::init<Netlist&>(), py::arg("netlist"), R"(
             Construct new NetlistTraversalDecorator object.

src/python_bindings/bindings/subgraph_netlist_decorator.cpp

@@ -6,7 +6,10 @@ namespace hal
 {
     void subgraph_netlist_decorator_init(py::module& m)
     {
-        py::class_<SubgraphNetlistDecorator> py_subgraph_netlist_decorator(m, "SubgraphNetlistDecorator", R"()");
+        py::class_<SubgraphNetlistDecorator> py_subgraph_netlist_decorator(
+            m,
+            "SubgraphNetlistDecorator",
+            R"(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.)");
 
         py_subgraph_netlist_decorator.def(py::init<const Netlist&>(), py::arg("netlist"), R"(
             Construct new SubgraphNetlistDecorator object.