fixed some documentation

Author: julianspeith

plugins/bitorder_propagation/include/bitorder_propagation/plugin_bitorder_propagation.h

@@ -39,7 +39,7 @@ namespace hal
 
     /**
      * @class BitorderPropagationPlugin
-     * @brief Plugin interface for bit order propoagation.
+     * @brief Plugin interface for the BitorderPropagationPlugin.
      * 
      * This class provides an interface to integrate the bit-order propagation as a plugin within the HAL framework.
      */

plugins/dot_viewer/CMakeLists.txt

@@ -22,6 +22,7 @@ if(PL_DOT_VIEWER OR BUILD_ALL_PLUGINS)
         HEADER  ${DOT_VIEWER_INC}
         SOURCES ${DOT_VIEWER_SRC} ${DOT_VIEWER_PYTHON_SRC} ${MOC_HDR}
         COMPILE_OPTIONS "-march=native"
+        PYDOC SPHINX_DOC_INDEX_FILE ${CMAKE_CURRENT_SOURCE_DIR}/documentation/dot_viewer.rst
     )
 
     target_sources(dot_viewer

plugins/dot_viewer/documentation/dot_viewer.rst

@@ -0,0 +1,8 @@
+DOT Viewer
+==========================
+
+.. automodule:: dot_viewer
+    :members: load_dot_file
+
+.. autoclass:: dot_viewer.DotViewerPlugin
+    :members:

plugins/dot_viewer/include/dot_viewer/plugin_dot_viewer.h

@@ -3,8 +3,7 @@
 // Copyright (c) 2019 Ruhr University Bochum, Chair for Embedded Security. All Rights reserved.
 // Copyright (c) 2019 Marc Fyrbiak, Sebastian Wallat, Max Hoffmann ("ORIGINAL AUTHORS"). All rights reserved.
 // Copyright (c) 2021 Max Planck Institute for Security and Privacy. All Rights reserved.
-// Copyright (c) 2021 Jörn Langheinrich, Julian Speith, Nils Albartus, René Walendy, Simon Klix ("ORIGINAL AUTHORS").
-// All Rights reserved.
+// Copyright (c) 2021 Jörn Langheinrich, Julian Speith, Nils Albartus, René Walendy, Simon Klix ("ORIGINAL AUTHORS"). All Rights reserved.
 //
 // Permission is hereby granted, free of charge, to any person obtaining a copy
 // of this software and associated documentation files (the "Software"), to deal
@@ -33,35 +32,64 @@
 
 namespace hal
 {
+    /* forward declaration */
     class Netlist;
     class DotViewer;
     class DotViewerSerializer;
-}
 
-namespace hal
-{
-    extern Netlist *gNetlist;
+    extern Netlist* gNetlist;
 
+    /**
+     * @class DotViewerPlugin
+     * @brief Plugin interface for the DotViewerPlugin.
+     * 
+     * This class provides an interface to integrate a .dot viewer as a plugin within the HAL framework.
+     */
     class PLUGIN_API DotViewerPlugin : public BasePluginInterface
     {
-      public:
+    public:
+        /** 
+         * @brief Default constructor for `DotViewerPlugin`.
+         */
         DotViewerPlugin();
 
+        /** 
+         * @brief Default destructor for `DotViewerPlugin`.
+         */
         ~DotViewerPlugin() = default;
 
+        /**
+         * @brief Get the name of the plugin.
+         *
+         * @returns The name of the plugin.
+         */
         std::string get_name() const override;
 
+        /**
+         * @brief Get the version of the plugin.
+         *
+         * @returns The version of the plugin.
+         */
         std::string get_version() const override;
 
+        /**
+         * @brief Get a short description of the plugin.
+         *
+         * @returns The short description of the plugin.
+         */
         std::string get_description() const override;
 
+        /**
+         * @brief Get the plugin dependencies.
+         * 
+         * @returns A set of plugin names that this plugin depends on.
+         */
         std::set<std::string> get_dependencies() const override;
 
         void initialize() override;
 
         void on_load() override;
 
         void on_unload() override;
-
     };
-}  // namespace hal
+}    // namespace hal

plugins/dot_viewer/python/python_bindings.cpp

@@ -1,11 +1,11 @@
 #include "hal_core/python_bindings/python_bindings.h"
 
+#include "dot_viewer/dot_viewer.h"
+#include "dot_viewer/plugin_dot_viewer.h"
 #include "pybind11/operators.h"
 #include "pybind11/pybind11.h"
 #include "pybind11/stl.h"
 #include "pybind11/stl_bind.h"
-#include "dot_viewer/plugin_dot_viewer.h"
-#include "dot_viewer/dot_viewer.h"
 
 namespace py = pybind11;
 
@@ -18,15 +18,15 @@ namespace hal
 #ifdef PYBIND11_MODULE
     PYBIND11_MODULE(dot_viewer, m)
     {
-        m.doc() = "Provides access to graphviz dot viewer plugin.";
+        m.doc() = "Plugin to visualize .dot graphs within the HAL GUI.";
 #else
     PYBIND11_PLUGIN(dot_viewer)
     {
-        py::module m("dot_viewer", "Provides access to graphviz dot viewer plugin.");
+        py::module m("dot_viewer", "Plugin to visualize .dot graphs within the HAL GUI.");
 #endif    // ifdef PYBIND11_MODULE
 
         py::class_<DotViewerPlugin, RawPtrWrapper<DotViewerPlugin>, BasePluginInterface> py_dotviewer_plugin(
-            m, "DotViewerPlugin", R"(This class provides a dot viewer as a plugin within the HAL framework.)");
+            m, "DotViewerPlugin", R"(This class provides an interface to integrate a .dot viewer as a plugin within the HAL framework.)");
 
         py_dotviewer_plugin.def_property_readonly("name", &DotViewerPlugin::get_name, R"(
             The name of the plugin.
@@ -82,22 +82,21 @@ namespace hal
 
         m.def(
             "load_dot_file",
-            [](const std::string& filename,
-               const std::string& creator_plugin = "") {
+            [](const std::string& filename, const std::string& creator_plugin = "") {
                 QString qfilename = QString::fromStdString(filename);
-                QString qcreator = QString::fromStdString(creator_plugin);
-                DotViewer* dv = DotViewer::getDotviewerInstance();
+                QString qcreator  = QString::fromStdString(creator_plugin);
+                DotViewer* dv     = DotViewer::getDotviewerInstance();
                 if (dv)
                 {
-                    dv->handleOpenInputFileByName(qfilename,qcreator);
+                    dv->handleOpenInputFileByName(qfilename, qcreator);
                 }
                 else
                 {
                     log_error("python_context", "Cannot find dot viewer instance.");
                 }
             },
             py::arg("filename"),
-            py::arg("creator_plugin")           = std::string(),
+            py::arg("creator_plugin") = std::string(),
             R"(
             Loads a dot file in the graphic viewer provided by dot_viewer plugin.