Skip to content

Commit b16aa15

Browse files
author
Éric Lemoine
committed
Improve qgsmessagelog doc strings
1 parent 3443102 commit b16aa15

File tree

2 files changed

+9
-6
lines changed

2 files changed

+9
-6
lines changed

python/core/auto_generated/qgsmessagelog.sip.in

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -108,7 +108,7 @@ class QgsMessageLogConsole : QObject
108108
Default implementation of message logging interface
109109

110110
This class outputs log messages to the standard error. Therefore it might
111-
be the right choice for apps without GUI.
111+
be the right choice for applications without GUI.
112112
%End
113113

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

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

130130
:param message: the message to format
131131
:param tag: the tag of the message
132132
:param level: the log level of the message
133+
134+
.. versionadded:: 3.4
133135
%End
134136

135137
public slots:
136138

137139
void logMessage( const QString &message, const QString &tag, Qgis::MessageLevel level );
138140
%Docstring
139-
Log a message to stderr.
141+
Logs a message to stderr.
140142

141143
:param message: the message to format
142144
:param tag: the tag of the message

src/core/qgsmessagelog.h

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -131,7 +131,7 @@ class CORE_EXPORT QgsMessageLogNotifyBlocker
131131
* \brief Default implementation of message logging interface
132132
*
133133
* This class outputs log messages to the standard error. Therefore it might
134-
* be the right choice for apps without GUI.
134+
* be the right choice for applications without GUI.
135135
*/
136136
class CORE_EXPORT QgsMessageLogConsole : public QObject
137137
{
@@ -147,18 +147,19 @@ class CORE_EXPORT QgsMessageLogConsole : public QObject
147147
protected:
148148

149149
/**
150-
* Format a log message. Used by child classes.
150+
* Formats a log message. Used by child classes.
151151
*
152152
* \param message the message to format
153153
* \param tag the tag of the message
154154
* \param level the log level of the message
155+
* \since QGIS 3.4
155156
*/
156157
QString formatLogMessage( const QString &message, const QString &tag, Qgis::MessageLevel level = Qgis::Info ) const;
157158

158159
public slots:
159160

160161
/**
161-
* Log a message to stderr.
162+
* Logs a message to stderr.
162163
*
163164
* \param message the message to format
164165
* \param tag the tag of the message

0 commit comments

Comments
 (0)