Skip to content
Permalink
Browse files

Improve qgsmessagelog doc strings

  • Loading branch information
Éric Lemoine
Éric Lemoine committed Sep 13, 2018
1 parent 3443102 commit b16aa15f06c88acba5430a563eccb2ea21b8e806
Showing with 9 additions and 6 deletions.
  1. +5 −3 python/core/auto_generated/qgsmessagelog.sip.in
  2. +4 −3 src/core/qgsmessagelog.h
@@ -108,7 +108,7 @@ class QgsMessageLogConsole : QObject
Default implementation of message logging interface

This class outputs log messages to the standard error. Therefore it might
be the right choice for apps without GUI.
be the right choice for applications without GUI.
%End

%TypeHeaderCode
@@ -125,18 +125,20 @@ Constructor for QgsMessageLogConsole.

QString formatLogMessage( const QString &message, const QString &tag, Qgis::MessageLevel level = Qgis::Info ) const;
%Docstring
Format a log message. Used by child classes.
Formats a log message. Used by child classes.

:param message: the message to format
:param tag: the tag of the message
:param level: the log level of the message

.. versionadded:: 3.4
%End

public slots:

void logMessage( const QString &message, const QString &tag, Qgis::MessageLevel level );
%Docstring
Log a message to stderr.
Logs a message to stderr.

:param message: the message to format
:param tag: the tag of the message
@@ -131,7 +131,7 @@ class CORE_EXPORT QgsMessageLogNotifyBlocker
* \brief Default implementation of message logging interface
*
* This class outputs log messages to the standard error. Therefore it might
* be the right choice for apps without GUI.
* be the right choice for applications without GUI.
*/
class CORE_EXPORT QgsMessageLogConsole : public QObject
{
@@ -147,18 +147,19 @@ class CORE_EXPORT QgsMessageLogConsole : public QObject
protected:

/**
* Format a log message. Used by child classes.
* Formats a log message. Used by child classes.
*
* \param message the message to format
* \param tag the tag of the message
* \param level the log level of the message
* \since QGIS 3.4
*/
QString formatLogMessage( const QString &message, const QString &tag, Qgis::MessageLevel level = Qgis::Info ) const;

public slots:

/**
* Log a message to stderr.
* Logs a message to stderr.
*
* \param message the message to format
* \param tag the tag of the message

0 comments on commit b16aa15

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