Skip to content

Commit 75e0948

Browse files
committedOct 5, 2017
[auth] More verbose docstrings
1 parent 3852e5d commit 75e0948

File tree

1 file changed

+12
-2
lines changed

1 file changed

+12
-2
lines changed
 

‎src/gui/auth/qgsauthsettingswidget.h

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,10 @@
2626
/** \ingroup gui
2727
* Widget for entering authentication credentials both in the form username/password
2828
* and by using QGIS Authentication Database and its authentication configurations.
29+
*
30+
* The widget also offers the functionality to convert username/password credentials
31+
* to an authentication configuration.
32+
*
2933
* \since QGIS 3.0
3034
*/
3135
class GUI_EXPORT QgsAuthSettingsWidget : public QWidget, private Ui::QgsAuthSettingsWidget
@@ -35,7 +39,13 @@ class GUI_EXPORT QgsAuthSettingsWidget : public QWidget, private Ui::QgsAuthSett
3539

3640
public:
3741

38-
//! Type of certificate usage
42+
/**
43+
* \brief The WarningType enum is used to determine the text
44+
* of the message shown to the user about the destination of
45+
* the stored clear-text credentials from the "Basic" tab:
46+
* depending on the provider or the settings, the credentials
47+
* are stored in the user settings and/or in the project file.
48+
*/
3949
enum WarningType
4050
{
4151
ProjectFile,
@@ -121,7 +131,7 @@ class GUI_EXPORT QgsAuthSettingsWidget : public QWidget, private Ui::QgsAuthSett
121131

122132
/**
123133
* \brief warning text message based upon where credentials are stored
124-
* \param enum of warning type
134+
* \param warning enum of warning type
125135
* \return pre-formatted warning text
126136
*/
127137
static const QString formattedWarning( WarningType warning );

0 commit comments

Comments
 (0)
Please sign in to comment.