Skip to content
Permalink
Browse files

Spelling and doxygen

  • Loading branch information
elpaso committed Jun 26, 2018
1 parent ab0c58d commit cfb20232de0f8d6e64eaf1035e358a7b193c908a
@@ -25,6 +25,7 @@
/**
* The QgsAuthOAuth2Config class stores the configuration for OAuth2 authentication plugin
* \ingroup auth_plugins
* \since QGIS 3.4
*/
class QgsAuthOAuth2Config : public QObject
{
@@ -87,6 +88,7 @@ class QgsAuthOAuth2Config : public QObject
Query,
};

//! Construct a QgsAuthOAuth2Config instance
explicit QgsAuthOAuth2Config( QObject *parent = nullptr );

//! Unique ID
@@ -143,7 +145,7 @@ class QgsAuthOAuth2Config : public QObject
//! API key
QString apiKey() const { return mApiKey; }

//! Return true if the token is persistant
//! Returns true if the token is persistent
bool persistToken() const { return mPersistToken; }

//! Access method
@@ -173,7 +175,7 @@ class QgsAuthOAuth2Config : public QObject
//! Save a config to a string (e.g. JSON)
QByteArray saveConfigTxt( ConfigFormat format = JSON, bool pretty = false, bool *ok = nullptr ) const;

//! Return the configuration as a QVariant map
//! Configuration as a QVariant map
QVariantMap mappedProperties() const;

/**
@@ -339,7 +341,7 @@ class QgsAuthOAuth2Config : public QObject
void apiKeyChanged( const QString & );

// advanced
//! Emitted when configuration persiste token flag has changed
//! Emitted when configuration persist token flag has changed
void persistTokenChanged( bool );
//! Emitted when configuration access method has changed
void accessMethodChanged( AccessMethod );
@@ -26,12 +26,15 @@
/**
* The QgsAuthOAuth2Edit class allows editing of an OAuth2 authentication configuration
* \ingroup auth_plugins
* \since QGIS 3.4
*/
class QgsAuthOAuth2Edit : public QgsAuthMethodEdit, private Ui::QgsAuthOAuth2Edit
{
Q_OBJECT

public:

//! Construct a QgsAuthOAuth2Edit instance
explicit QgsAuthOAuth2Edit( QWidget *parent = nullptr );
virtual ~QgsAuthOAuth2Edit() = default;

@@ -30,6 +30,7 @@ class QgsO2;
/**
* The QgsAuthOAuth2Method class handles all network connection operation for the OAuth2 authentication plugin
* \ingroup auth_plugins
* \since QGIS 3.4
*/
class QgsAuthOAuth2Method : public QgsAuthMethod
{
@@ -22,6 +22,8 @@ class QgsAuthOAuth2Config;
/**
* QGIS-specific subclass of O2 lib's base OAuth 2.0 authenticator.
* Adds support for QGIS authentication system.
* \ingroup auth_plugins
* \since QGIS 3.4
*/
class QgsO2: public O2
{

0 comments on commit cfb2023

Please sign in to comment.
You can’t perform that action at this time.