Add missing doxygen comments (#1223)

Fixes #1218
This commit is contained in:
Alex Kremer
2024-03-01 15:58:18 +00:00
committed by GitHub
parent b3e63b2491
commit a74970b81e
125 changed files with 2755 additions and 365 deletions

View File

@@ -33,12 +33,30 @@ class HandlerProvider {
public:
virtual ~HandlerProvider() = default;
/**
* @brief Check if the provider contains a handler for a given method
*
* @param command The method to check for
* @return true if the provider contains a handler for the method, false otherwise
*/
virtual bool
contains(std::string const& method) const = 0;
contains(std::string const& command) const = 0;
/**
* @brief Get the handler for a given method
*
* @param command The method to get the handler for
* @return The handler for the method, or std::nullopt if the method is not found
*/
virtual std::optional<AnyHandler>
getHandler(std::string const& command) const = 0;
/**
* @brief Check if a given method is Clio-only
*
* @param command The method to check
* @return true if the method is Clio-only, false otherwise
*/
virtual bool
isClioOnly(std::string const& command) const = 0;
};