fix "No such ..." in qmargins
authorJeremy Katz <jeremy.katz@nokia.com>
Wed, 18 Jul 2012 23:16:38 +0000 (01:16 +0200)
committerQt by Nokia <qt-info@nokia.com>
Thu, 19 Jul 2012 10:35:07 +0000 (12:35 +0200)
Is it more appropriate to rename the parameter in question
"margin", as suggested by the documentation, or have the
documentation refer to "m", as suggested by the code?

Change-Id: I5768ef044164e099ef1db77adda42171799cbf12
Reviewed-by: Casper van Donderen <casper.vandonderen@nokia.com>
src/corelib/tools/qmargins.cpp

index 41f7dce..f316746 100644 (file)
@@ -164,7 +164,7 @@ QT_BEGIN_NAMESPACE
     \fn QDataStream &operator<<(QDataStream &stream, const QMargins &m)
     \relates QMargins
 
-    Writes the given \a margin to the given \a stream and returns a
+    Writes margin \a m to the given \a stream and returns a
     reference to the stream.
 
     \sa {Serializing Qt Data Types}
@@ -180,7 +180,7 @@ QDataStream &operator<<(QDataStream &s, const QMargins &m)
     \fn QDataStream &operator>>(QDataStream &stream, QMargins &m)
     \relates QMargins
 
-    Reads a margin from the given \a stream into the given \a margin
+    Reads a margin from the given \a stream into margin \a m
     and returns a reference to the stream.
 
     \sa {Serializing Qt Data Types}