diff options
author | Saturneric <[email protected]> | 2022-01-14 11:35:01 +0000 |
---|---|---|
committer | Saturneric <[email protected]> | 2022-01-14 11:35:01 +0000 |
commit | 990aefc086795d74170b22055c5051595ce5b0fc (patch) | |
tree | 65354401a49d0b8cf2eb82fb17d580abff6476cc /src/gpg/function/GpgCommandExecutor.h | |
parent | <feat>(project): Generate compile commands.json by default (diff) | |
download | GpgFrontend-990aefc086795d74170b22055c5051595ce5b0fc.tar.gz GpgFrontend-990aefc086795d74170b22055c5051595ce5b0fc.zip |
<doc>(core): add comment for code
Diffstat (limited to 'src/gpg/function/GpgCommandExecutor.h')
-rw-r--r-- | src/gpg/function/GpgCommandExecutor.h | 17 |
1 files changed, 11 insertions, 6 deletions
diff --git a/src/gpg/function/GpgCommandExecutor.h b/src/gpg/function/GpgCommandExecutor.h index 6979d5f6..5e8c19c1 100644 --- a/src/gpg/function/GpgCommandExecutor.h +++ b/src/gpg/function/GpgCommandExecutor.h @@ -35,11 +35,16 @@ namespace GpgFrontend { /** - * @brief + * @brief Extra commands related to GPG * */ class GpgCommandExecutor : public SingletonFunctionObject<GpgCommandExecutor> { public: + /** + * @brief Construct a new Gpg Command Executor object + * + * @param channel Corresponding context + */ explicit GpgCommandExecutor( int channel = SingletonFunctionObject::GetDefaultChannel()) : SingletonFunctionObject<GpgCommandExecutor>(channel) {} @@ -47,10 +52,10 @@ class GpgCommandExecutor : public SingletonFunctionObject<GpgCommandExecutor> { #ifndef WINDOWS /** - * @brief + * @brief Excuting an order * - * @param arguments - * @param interact_func + * @param arguments Command parameters + * @param interact_func Command answering function */ void Execute(StringArgsRef arguments, const std::function<void(boost::process::async_pipe &in, @@ -59,8 +64,8 @@ class GpgCommandExecutor : public SingletonFunctionObject<GpgCommandExecutor> { #endif private: - GpgContext &ctx = - GpgContext::GetInstance(SingletonFunctionObject::GetChannel()); + GpgContext &ctx = GpgContext::GetInstance( + SingletonFunctionObject::GetChannel()); ///< Corresponding context }; } // namespace GpgFrontend |