[auth] Sipify and doxify

qgis · Oct 16, 2017 · b3fc3a4 · b3fc3a4
1 parent b760f08
commit b3fc3a4
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 4 deletions.
diff --git a/python/core/auth/qgsauthconfig.sip b/python/core/auth/qgsauthconfig.sip
@@ -349,12 +349,15 @@ Set private key object
 
     QList<QSslCertificate> caChain() const;
 %Docstring
-Return CA chain
+ caChain return the CA chain
+ :return: list of CA certificates
  :rtype: list of QSslCertificate
 %End
+
     void setCaChain( const QList<QSslCertificate> &caChain );
 %Docstring
-Set CA chain
+ setCaChain set the CA chain
+ \param caChain
 %End
 
 };

diff --git a/src/core/auth/qgsauthconfig.h b/src/core/auth/qgsauthconfig.h
@@ -288,9 +288,16 @@ class CORE_EXPORT QgsPkiConfigBundle
     //! Set private key object
     void setClientCertKey( const QSslKey &certkey ) { mCertKey = certkey; }
 
-    //! Return CA chain
+    /**
+     * \brief caChain return the CA chain
+     * \return list of CA certificates
+     */
     QList<QSslCertificate> caChain() const { return mCaChain; }
-    //! Set CA chain
+
+    /**
+     * \brief setCaChain set the CA chain
+     * \param caChain
+     */
     void setCaChain( const QList<QSslCertificate> &caChain ) { mCaChain = caChain; }
 
   private: