Add note to use QgsApplication::authManager()

qgis · Jun 3, 2018 · 9115d7f · 9115d7f
1 parent 477fb89
commit 9115d7f
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 0 deletions.
diff --git a/python/core/auto_generated/auth/qgsauthmanager.sip.in b/python/core/auto_generated/auth/qgsauthmanager.sip.in
@@ -18,6 +18,9 @@ class QgsAuthManager : QObject
 %Docstring
 Singleton offering an interface to manage the authentication configuration database
 and to utilize configurations through various authentication method plugins
+
+QgsAuthManager should not usually be directly created, but rather accessed through
+:py:func:`QgsApplication.authManager()`
 %End
 
 %TypeHeaderCode

diff --git a/src/core/auth/qgsauthmanager.h b/src/core/auth/qgsauthmanager.h
@@ -57,6 +57,9 @@ class QTimer;
  * \ingroup core
  * Singleton offering an interface to manage the authentication configuration database
  * and to utilize configurations through various authentication method plugins
+ *
+ * QgsAuthManager should not usually be directly created, but rather accessed through
+ * QgsApplication::authManager().
  */
 class CORE_EXPORT QgsAuthManager : public QObject
 {