From 5a8dbd715993644486c327e06bd01ec530f3392e Mon Sep 17 00:00:00 2001
From: Jan Kolarik <jkolarik@redhat.com>
Date: Fri, 8 Dec 2023 15:55:59 +0100
Subject: [PATCH] doc: Update docstrings for plugins' base classes

And some final docs fixups.
---
 dnf5/include/dnf5/iplugin.hpp      |  5 +----
 dnf5/plugins.cpp                   | 11 -----------
 doc/libdnf5_plugins/actions.8.rst  |  6 +++---
 include/libdnf5/plugin/iplugin.hpp |  1 +
 4 files changed, 5 insertions(+), 18 deletions(-)

diff --git a/dnf5/include/dnf5/iplugin.hpp b/dnf5/include/dnf5/iplugin.hpp
index d7f423443..e1528face 100644
--- a/dnf5/include/dnf5/iplugin.hpp
+++ b/dnf5/include/dnf5/iplugin.hpp
@@ -34,6 +34,7 @@ struct PluginVersion {
     std::uint16_t micro;
 };
 
+/// @brief A base class for implementing DNF5 plugins that provide one or more commands to users.
 class IPlugin {
 public:
     IPlugin(Context & context) : context(&context) {}
@@ -65,10 +66,6 @@ class IPlugin {
 
     virtual std::vector<std::unique_ptr<Command>> create_commands() = 0;
 
-    /// It is called when a hook is reached. The argument describes what happened.
-    // TODO(jrohel): Design an API for a different plugin type than command. For example, to modify or log output.
-    //virtual bool hook(HookId hook_id) = 0;
-
     /// Finish the plugin and release all resources obtained by the init method and in hooks.
     virtual void finish() noexcept = 0;
 
diff --git a/dnf5/plugins.cpp b/dnf5/plugins.cpp
index fae106e8a..b0eaae782 100644
--- a/dnf5/plugins.cpp
+++ b/dnf5/plugins.cpp
@@ -158,17 +158,6 @@ bool Plugins::init() {
     return true;
 }
 
-/*bool Plugins::hook(HookId id) {
-    for (auto & plugin : plugins) {
-        if (plugin->get_enabled()) {
-            if (!plugin->hook(id)) {
-                return false;
-            }
-        }
-    }
-    return true;
-}*/
-
 void Plugins::finish() noexcept {
     for (auto plugin = plugins.rbegin(), stop = plugins.rend(); plugin != stop; ++plugin) {
         if ((*plugin)->get_enabled()) {
diff --git a/doc/libdnf5_plugins/actions.8.rst b/doc/libdnf5_plugins/actions.8.rst
index 8d50604a3..312bdec32 100644
--- a/doc/libdnf5_plugins/actions.8.rst
+++ b/doc/libdnf5_plugins/actions.8.rst
@@ -18,9 +18,9 @@
 
 .. _actions_plugin_ref-label:
 
-======================
-libdnf5 Actions Plugin
-======================
+==============
+Actions Plugin
+==============
 
 Description
 ===========
diff --git a/include/libdnf5/plugin/iplugin.hpp b/include/libdnf5/plugin/iplugin.hpp
index d052690ab..91a5e17fa 100644
--- a/include/libdnf5/plugin/iplugin.hpp
+++ b/include/libdnf5/plugin/iplugin.hpp
@@ -44,6 +44,7 @@ struct Version {
     std::uint16_t micro;
 };
 
+/// @brief A base class for implementing LIBDNF5 plugins that introduce additional logic into the library using hooks.
 class IPlugin {
 public:
     IPlugin(Base & base) : base(&base) {}