Add docs for more QgsMessageLogConsole methods

qgis · Sep 11, 2018 · 504657e · 504657e
1 parent 212a74c
commit 504657e
Show file tree

Hide file tree

Showing 2 changed files with 24 additions and 0 deletions.
diff --git a/python/core/auto_generated/qgsmessagelog.sip.in b/python/core/auto_generated/qgsmessagelog.sip.in
@@ -115,7 +115,11 @@ be the right choice for apps without GUI.
 #include "qgsmessagelog.h"
 %End
   public:
+
     QgsMessageLogConsole();
+%Docstring
+Constructor for QgsMessageLogConsole.
+%End
 
   protected:
 
@@ -129,7 +133,15 @@ Format a log message. Used by child classes.
 %End
 
   public slots:
+
     void logMessage( const QString &message, const QString &tag, Qgis::MessageLevel level );
+%Docstring
+Log a message to stderr.
+
+:param message: the message to format
+:param tag: the tag of the message
+:param level: the log level of the message
+%End
 };
 
 /************************************************************************

diff --git a/src/core/qgsmessagelog.h b/src/core/qgsmessagelog.h
@@ -138,6 +138,10 @@ class CORE_EXPORT QgsMessageLogConsole : public QObject
     Q_OBJECT
 
   public:
+
+    /**
+     * Constructor for QgsMessageLogConsole.
+     */
     QgsMessageLogConsole();
 
   protected:
@@ -152,6 +156,14 @@ class CORE_EXPORT QgsMessageLogConsole : public QObject
     QString formatLogMessage( const QString &message, const QString &tag, Qgis::MessageLevel level = Qgis::Info ) const;
 
   public slots:
+
+    /**
+     * Log a message to stderr.
+     *
+     * \param message the message to format
+     * \param tag the tag of the message
+     * \param level the log level of the message
+     */
     void logMessage( const QString &message, const QString &tag, Qgis::MessageLevel level );
 };