Commit 6ef1eb53 authored by Dan Leinir Turthra Jensen's avatar Dan Leinir Turthra Jensen 🌈
Browse files

A touch of documentation for the jobs

parent 04478c7d
......@@ -25,6 +25,9 @@
#include <QStringList>
/**
* @brief A job used to change the enabled state of a specific service on a specific account
*/
class KACCOUNTS_EXPORT AccountServiceToggleJob : public KJob
{
Q_OBJECT
......
......@@ -25,6 +25,12 @@
#include <QStringList>
/**
* @brief A job used to change the human-readable name of a specified account
*
* This job will refuse to change the name to something empty (while it is technically
* possible to do so for an account, it is highly undesirable)
*/
class KACCOUNTS_EXPORT ChangeAccountDisplayNameJob : public KJob
{
Q_OBJECT
......
......@@ -39,6 +39,9 @@ namespace SignOn
class IdentityInfo;
}
/**
* @brief Create a new account for the specified provider
*/
class KACCOUNTS_EXPORT CreateAccountJob : public KJob
{
Q_OBJECT
......
......@@ -30,7 +30,7 @@ namespace Accounts {
}
/**
* A KJob for obtaining user's credentials for the given Accounts::AccountId
* @brief A KJob for obtaining user's credentials for the given Accounts::AccountId
*/
class KACCOUNTS_EXPORT GetCredentialsJob : public KJob
{
......
......@@ -25,6 +25,9 @@
#include <QString>
/**
* @brief A job which will attempt to remove the specified account
*/
class KACCOUNTS_EXPORT RemoveAccountJob : public KJob
{
Q_OBJECT
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment