Add documentation for set_useragent().
All checks were successful
continuous-integration/drone/push Build is passing

This commit is contained in:
tastytea 2020-01-14 23:28:20 +01:00
parent 968863301a
commit 7afc8d19a9
Signed by: tastytea
GPG Key ID: CFC39497F1B26E07
2 changed files with 18 additions and 0 deletions

View File

@ -239,6 +239,11 @@ protected:
*/ */
void set_cainfo(string_view path); void set_cainfo(string_view path);
/*!
* @brief Sets the User-Agent.
*
* @since 0.3.0
*/
void set_useragent(string_view useragent); void set_useragent(string_view useragent);
private: private:

View File

@ -189,6 +189,14 @@ public:
CURLWrapper::set_cainfo(path); CURLWrapper::set_cainfo(path);
} }
/*!
* @brief Sets the User-Agent.
*
* Sets also the User-Agent for all Connection%s that are initialized with
* this Instance afterwards.
*
* @since 0.3.0
*/
void set_useragent(const string_view useragent) void set_useragent(const string_view useragent)
{ {
_useragent = useragent; _useragent = useragent;
@ -226,6 +234,11 @@ public:
class ObtainToken : public CURLWrapper class ObtainToken : public CURLWrapper
{ {
public: public:
/*!
* @brief Constructor.
*
* @since 0.3.0
*/
explicit ObtainToken(Instance &instance) explicit ObtainToken(Instance &instance)
: _instance{instance} : _instance{instance}
, _baseuri{instance.get_baseuri()} , _baseuri{instance.get_baseuri()}