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/GpgKeyGetter.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 '')
-rw-r--r-- | src/gpg/function/GpgKeyGetter.h | 48 |
1 files changed, 48 insertions, 0 deletions
diff --git a/src/gpg/function/GpgKeyGetter.h b/src/gpg/function/GpgKeyGetter.h index fcd518d3..e4700d5a 100644 --- a/src/gpg/function/GpgKeyGetter.h +++ b/src/gpg/function/GpgKeyGetter.h @@ -31,25 +31,73 @@ namespace GpgFrontend { +/** + * @brief + * + */ class GpgKeyGetter : public SingletonFunctionObject<GpgKeyGetter> { public: + /** + * @brief Construct a new Gpg Key Getter object + * + * @param channel + */ explicit GpgKeyGetter( int channel = SingletonFunctionObject::GetDefaultChannel()) : SingletonFunctionObject<GpgKeyGetter>(channel) {} + /** + * @brief Get the Key object + * + * @param fpr + * @return GpgKey + */ GpgKey GetKey(const std::string& fpr); + /** + * @brief Get the Keys object + * + * @param ids + * @return KeyListPtr + */ KeyListPtr GetKeys(const KeyIdArgsListPtr& ids); + /** + * @brief Get the Pubkey object + * + * @param fpr + * @return GpgKey + */ GpgKey GetPubkey(const std::string& fpr); + /** + * @brief + * + * @return KeyLinkListPtr + */ KeyLinkListPtr FetchKey(); + /** + * @brief Get the Keys Copy object + * + * @param keys + * @return KeyListPtr + */ static KeyListPtr GetKeysCopy(const KeyListPtr& keys); + /** + * @brief Get the Keys Copy object + * + * @param keys + * @return KeyLinkListPtr + */ static KeyLinkListPtr GetKeysCopy(const KeyLinkListPtr& keys); private: + /** + * @brief + * + */ GpgContext& ctx = GpgContext::GetInstance(SingletonFunctionObject::GetChannel()); }; |