more documentation cleanup

emsec · Jun 3, 2024 · ec57fca · ec57fca
1 parent c49bff2
commit ec57fca
Show file tree

Hide file tree

Showing 5 changed files with 15 additions and 9 deletions.
diff --git a/plugins/graph_algorithm/documentation/graph_algorithm.rst b/plugins/graph_algorithm/documentation/graph_algorithm.rst
@@ -2,4 +2,10 @@ Graph Algorithms
 ==========================
 
 .. automodule:: graph_algorithm
+    :members: get_connected_components, get_neighborhood, get_shortest_paths, get_all_shortest_paths, get_subgraph
+
+.. autoclass:: graph_algorithm.GraphAlgorithmPlugin
     :members:
+
+.. autoclass:: graph_algorithm.NetlistGraph
+    :members:
diff --git a/plugins/graph_algorithm/python/python_bindings.cpp b/plugins/graph_algorithm/python/python_bindings.cpp
@@ -35,11 +35,11 @@ namespace hal
 #ifdef PYBIND11_MODULE
     PYBIND11_MODULE(graph_algorithm, m)
     {
-        m.doc() = "hal GraphAlgorithmPlugin python bindings";
+        m.doc() = "Graph algorithms based on igraph operating on a netlist graph abstraction.";
 #else
     PYBIND11_PLUGIN(graph_algorithm)
     {
-        py::module m("graph_algorithm", "hal GraphAlgorithmPlugin python bindings");
+        py::module m("graph_algorithm", "Graph algorithms based on igraph operating on a netlist graph abstraction.");
 #endif    // ifdef PYBIND11_MODULE
 
         py::class_<GraphAlgorithmPlugin, RawPtrWrapper<GraphAlgorithmPlugin>, BasePluginInterface> py_graph_algorithm_plugin(m, "GraphAlgorithmPlugin");

diff --git a/plugins/hawkeye/documentation/hawkeye.rst b/plugins/hawkeye/documentation/hawkeye.rst
@@ -1,6 +1,9 @@
 HAWKEYE
 ==========================
 
+.. automodule:: hawkeye
+    :members: detect_candidates, locate_sboxes, identify_sbox
+
 .. autoclass:: hawkeye.HawkeyePlugin
     :members:
 
@@ -27,7 +30,4 @@ HAWKEYE
 .. autoclass:: hawkeye.SBoxDatabase
     :members:
 
-    .. automethod:: __init__
-
-.. automodule:: hawkeye
-    :members: detect_candidates, locate_sboxes, identify_sbox
+    .. automethod:: __init__
diff --git a/plugins/hawkeye/python/python_bindings.cpp b/plugins/hawkeye/python/python_bindings.cpp
@@ -21,11 +21,11 @@ namespace hal
 #ifdef PYBIND11_MODULE
     PYBIND11_MODULE(hawkeye, m)
     {
-        m.doc() = "hal HawkeyePlugin python bindings";
+        m.doc() = "Automated tool to locate arbitrary symmetric cryptographic implementations in gate-level netlists.";
 #else
     PYBIND11_PLUGIN(hawkeye)
     {
-        py::module m("hawkeye", "hal HawkeyePlugin python bindings");
+        py::module m("hawkeye", "Automated tool to locate arbitrary symmetric cryptographic implementations in gate-level netlists.");
 #endif    // ifdef PYBIND11_MODULE
 
         py::class_<HawkeyePlugin, RawPtrWrapper<HawkeyePlugin>, BasePluginInterface> py_hawkeye_plugin(

diff --git a/plugins/hawkeye/src/plugin_hawkeye.cpp b/plugins/hawkeye/src/plugin_hawkeye.cpp
@@ -19,7 +19,7 @@ namespace hal
 
     std::string HawkeyePlugin::get_description() const
     {
-        return "Attempts to locate arbitrary symmetric cryptographic implementations.";
+        return "Automated tool to locate arbitrary symmetric cryptographic implementations in gate-level netlists.";
     }
 
     std::set<std::string> HawkeyePlugin::get_dependencies() const