summaryrefslogtreecommitdiffstats
path: root/src/corelib/global
diff options
context:
space:
mode:
authorLaszlo Papp <lpapp@kde.org>2013-02-19 23:52:48 +0000
committerThe Qt Project <gerrit-noreply@qt-project.org>2013-02-20 01:30:29 +0100
commit2f5b4d47f6da4702dc6bfd411289aedf612bed6a (patch)
tree5e03182b9ff7ba0ececa8a3e5f4cfc2b59917d0b /src/corelib/global
parent7203e88084a313fb6e7a96b9080f965e3ffcd89f (diff)
Document the qintptr for public usage
The QAbstractSocket API has been already using this as a return type. Hence, this has already been exposed to the public API users, anyhow. http://qt-project.org/doc/qt-5.0/qtnetwork/qabstractsocket.html#socketDescriptor A minor mistake has also been fixed in this commit at the quintptr section. Change-Id: I8143b3050428548ff6baee2e3a0bce4058ea8701 Reviewed-by: Thiago Macieira <thiago.macieira@intel.com>
Diffstat (limited to 'src/corelib/global')
-rw-r--r--src/corelib/global/qglobal.cpp22
1 files changed, 20 insertions, 2 deletions
diff --git a/src/corelib/global/qglobal.cpp b/src/corelib/global/qglobal.cpp
index a0c12b7b06..7fd9283579 100644
--- a/src/corelib/global/qglobal.cpp
+++ b/src/corelib/global/qglobal.cpp
@@ -643,11 +643,29 @@ Q_CORE_EXPORT void *qMemSet(void *dest, int c, size_t n);
*/
/*!
+ \typedef qintptr
+ \relates <QtGlobal>
+
+ Integral type for representing pointers in a signed integer (useful for
+ hashing, etc.).
+
+ Typedef for either qint32 or qint64. This type is guaranteed to
+ be the same size as a pointer on all platforms supported by Qt. On
+ a system with 32-bit pointers, qintptr is a typedef for qint32;
+ on a system with 64-bit pointers, qintptr is a typedef for
+ qint64.
+
+ Note that qintptr is signed. Use quintptr for unsigned values.
+
+ \sa qptrdiff, qint32, qint64
+*/
+
+/*!
\typedef quintptr
\relates <QtGlobal>
- Integral type for representing a pointers (useful for hashing,
- etc.).
+ Integral type for representing pointers in an unsigned integer (useful for
+ hashing, etc.).
Typedef for either quint32 or quint64. This type is guaranteed to
be the same size as a pointer on all platforms supported by Qt. On