AuroraMiddleware/qt5base-lts
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Simplify Foundation conversion function documentation

Browse Source 
The \fn command to specify the function signature is not needed when
the documentation precedes the function itself.

Change-Id: I9de0d1ae73af443f0beded77538d62cea85b5e72
Reviewed-by: Timur Pocheptsov <timur.pocheptsov@theqtcompany.com>
This commit is contained in:
Tor Arne Vestbø 2016-05-13 13:05:55 +02:00 committed by Jake Petroules
parent 74d7824c1f
commit 87c426d5f4
1 changed files with 22 additions and 25 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

47
src/corelib/kernel/qcore_foundation.mm
View File

@ -49,7 +49,7 @@
QT_BEGIN_NAMESPACE QT_BEGIN_NAMESPACE
/*! \fn QByteArray QByteArray::fromCFData(CFDataRef data) /*!
\since 5.3 \since 5.3
Constructs a new QByteArray containing a copy of the CFData \a data. Constructs a new QByteArray containing a copy of the CFData \a data.
@ -64,7 +64,7 @@ QByteArray QByteArray::fromCFData(CFDataRef data)
return QByteArray(reinterpret_cast<const char *>(CFDataGetBytePtr(data)), CFDataGetLength(data)); return QByteArray(reinterpret_cast<const char *>(CFDataGetBytePtr(data)), CFDataGetLength(data));
} }
/*! \fn QByteArray QByteArray::fromRawCFData(CFDataRef data) /*!
\since 5.3 \since 5.3
Constructs a QByteArray that uses the bytes of the CFData \a data. Constructs a QByteArray that uses the bytes of the CFData \a data.
@ -84,7 +84,7 @@ QByteArray QByteArray::fromRawCFData(CFDataRef data)
return QByteArray::fromRawData(reinterpret_cast<const char *>(CFDataGetBytePtr(data)), CFDataGetLength(data)); return QByteArray::fromRawData(reinterpret_cast<const char *>(CFDataGetBytePtr(data)), CFDataGetLength(data));
} }
/*! \fn CFDataRef QByteArray::toCFData() const /*!
\since 5.3 \since 5.3
Creates a CFData from a QByteArray. The caller owns the CFData object Creates a CFData from a QByteArray. The caller owns the CFData object
@ -97,7 +97,7 @@ CFDataRef QByteArray::toCFData() const
return CFDataCreate(kCFAllocatorDefault, reinterpret_cast<const UInt8 *>(data()), length()); return CFDataCreate(kCFAllocatorDefault, reinterpret_cast<const UInt8 *>(data()), length());
} }
/*! \fn CFDataRef QByteArray::toRawCFData() const /*!
\since 5.3 \since 5.3
Constructs a CFData that uses the bytes of the QByteArray. Constructs a CFData that uses the bytes of the QByteArray.
@ -109,14 +109,13 @@ CFDataRef QByteArray::toCFData() const
\sa toCFData(), fromRawCFData(), fromCFData(), fromRawData() \sa toCFData(), fromRawCFData(), fromCFData(), fromRawData()
*/ */
CFDataRef QByteArray::toRawCFData() const CFDataRef QByteArray::toRawCFData() const
{ {
return CFDataCreateWithBytesNoCopy(kCFAllocatorDefault, reinterpret_cast<const UInt8 *>(data()), return CFDataCreateWithBytesNoCopy(kCFAllocatorDefault, reinterpret_cast<const UInt8 *>(data()),
length(), kCFAllocatorNull); length(), kCFAllocatorNull);
} }
/*! \fn QByteArray QByteArray::fromNSData(const NSData *data) /*!
\since 5.3 \since 5.3
Constructs a new QByteArray containing a copy of the NSData \a data. Constructs a new QByteArray containing a copy of the NSData \a data.
@ -130,7 +129,7 @@ QByteArray QByteArray::fromNSData(const NSData *data)
return QByteArray(reinterpret_cast<const char *>([data bytes]), [data length]); return QByteArray(reinterpret_cast<const char *>([data bytes]), [data length]);
} }
/*! \fn QByteArray QByteArray::fromRawNSData(const NSData *data) /*!
\since 5.3 \since 5.3
Constructs a QByteArray that uses the bytes of the NSData \a data. Constructs a QByteArray that uses the bytes of the NSData \a data.
@ -149,7 +148,7 @@ QByteArray QByteArray::fromRawNSData(const NSData *data)
return QByteArray::fromRawData(reinterpret_cast<const char *>([data bytes]), [data length]); return QByteArray::fromRawData(reinterpret_cast<const char *>([data bytes]), [data length]);
} }
/*! \fn NSData QByteArray::toNSData() const /*!
\since 5.3 \since 5.3
Creates a NSData from a QByteArray. The NSData object is autoreleased. Creates a NSData from a QByteArray. The NSData object is autoreleased.
@ -161,7 +160,7 @@ NSData *QByteArray::toNSData() const
return [NSData dataWithBytes:constData() length:size()]; return [NSData dataWithBytes:constData() length:size()];
} }
/*! \fn NSData QByteArray::toRawNSData() const /*!
\since 5.3 \since 5.3
Constructs a NSData that uses the bytes of the QByteArray. Constructs a NSData that uses the bytes of the QByteArray.
@ -181,7 +180,7 @@ NSData *QByteArray::toRawNSData() const
// ---------------------------------------------------------------------------- // ----------------------------------------------------------------------------
/*! \fn QString QString::fromCFString(CFStringRef string) /*!
\since 5.2 \since 5.2
Constructs a new QString containing a copy of the \a string CFString. Constructs a new QString containing a copy of the \a string CFString.
@ -205,7 +204,7 @@ QString QString::fromCFString(CFStringRef string)
return ret; return ret;
} }
/*! \fn CFStringRef QString::toCFString() const /*!
\since 5.2 \since 5.2
Creates a CFString from a QString. The caller owns the CFString and is Creates a CFString from a QString. The caller owns the CFString and is
@ -218,7 +217,7 @@ CFStringRef QString::toCFString() const
return CFStringCreateWithCharacters(0, reinterpret_cast<const UniChar *>(unicode()), length()); return CFStringCreateWithCharacters(0, reinterpret_cast<const UniChar *>(unicode()), length());
} }
/*! \fn QString QString::fromNSString(const NSString *string) /*!
\since 5.2 \since 5.2
Constructs a new QString containing a copy of the \a string NSString. Constructs a new QString containing a copy of the \a string NSString.
@ -235,7 +234,7 @@ QString QString::fromNSString(const NSString *string)
return qstring; return qstring;
} }
/*! \fn NSString QString::toNSString() const /*!
\since 5.2 \since 5.2
Creates a NSString from a QString. The NSString is autoreleased. Creates a NSString from a QString. The NSString is autoreleased.
@ -249,7 +248,7 @@ NSString *QString::toNSString() const
// ---------------------------------------------------------------------------- // ----------------------------------------------------------------------------
/*! \fn QUuid QUuid::fromCFUUID(CFUUIDRef uuid) /*!
\since 5.7 \since 5.7
Constructs a new QUuid containing a copy of the \a uuid CFUUID. Constructs a new QUuid containing a copy of the \a uuid CFUUID.
@ -264,7 +263,7 @@ QUuid QUuid::fromCFUUID(CFUUIDRef uuid)
return QUuid::fromRfc4122(QByteArray::fromRawData(reinterpret_cast<const char *>(&bytes), sizeof(bytes))); return QUuid::fromRfc4122(QByteArray::fromRawData(reinterpret_cast<const char *>(&bytes), sizeof(bytes)));
} }
/*! \fn CFUUIDRef QUuid::toCFUUID() const /*!
\since 5.7 \since 5.7
Creates a CFUUID from a QUuid. The caller owns the CFUUID and is Creates a CFUUID from a QUuid. The caller owns the CFUUID and is
@ -278,7 +277,7 @@ CFUUIDRef QUuid::toCFUUID() const
return CFUUIDCreateFromUUIDBytes(0, *reinterpret_cast<const CFUUIDBytes *>(bytes.constData())); return CFUUIDCreateFromUUIDBytes(0, *reinterpret_cast<const CFUUIDBytes *>(bytes.constData()));
} }
/*! \fn QUuid QUuid::fromNSUUID(const NSUUID *uuid) /*!
\since 5.7 \since 5.7
Constructs a new QUuid containing a copy of the \a uuid NSUUID. Constructs a new QUuid containing a copy of the \a uuid NSUUID.
@ -294,7 +293,7 @@ QUuid QUuid::fromNSUUID(const NSUUID *uuid)
return QUuid::fromRfc4122(QByteArray::fromRawData(reinterpret_cast<const char *>(bytes), sizeof(bytes))); return QUuid::fromRfc4122(QByteArray::fromRawData(reinterpret_cast<const char *>(bytes), sizeof(bytes)));
} }
/*! \fn NSUUID QUuid::toNSUUID() const /*!
\since 5.7 \since 5.7
Creates a NSUUID from a QUuid. The NSUUID is autoreleased. Creates a NSUUID from a QUuid. The NSUUID is autoreleased.
@ -310,7 +309,7 @@ NSUUID *QUuid::toNSUUID() const
// ---------------------------------------------------------------------------- // ----------------------------------------------------------------------------
/*! \fn QUrl QUrl::fromCFURL(CFURLRef url) /*!
\since 5.2 \since 5.2
Constructs a QUrl containing a copy of the CFURL \a url. Constructs a QUrl containing a copy of the CFURL \a url.
@ -320,7 +319,7 @@ QUrl QUrl::fromCFURL(CFURLRef url)
return QUrl(QString::fromCFString(CFURLGetString(url))); return QUrl(QString::fromCFString(CFURLGetString(url)));
} }
/*! \fn CFURLRef QUrl::toCFURL() const /*!
\since 5.2 \since 5.2
Creates a CFURL from a QUrl. The caller owns the CFURL and is Creates a CFURL from a QUrl. The caller owns the CFURL and is
@ -338,7 +337,6 @@ CFURLRef QUrl::toCFURL() const
} }
/*! /*!
\fn QUrl QUrl::fromNSURL(const NSURL *url)
\since 5.2 \since 5.2
Constructs a QUrl containing a copy of the NSURL \a url. Constructs a QUrl containing a copy of the NSURL \a url.
@ -349,7 +347,6 @@ QUrl QUrl::fromNSURL(const NSURL *url)
} }
/*! /*!
\fn NSURL* QUrl::toNSURL() const
\since 5.2 \since 5.2
Creates a NSURL from a QUrl. The NSURL is autoreleased. Creates a NSURL from a QUrl. The NSURL is autoreleased.
@ -362,7 +359,7 @@ NSURL *QUrl::toNSURL() const
// ---------------------------------------------------------------------------- // ----------------------------------------------------------------------------
/*! \fn QDateTime QDateTime::fromCFDate(CFDateRef date) /*!
\since 5.5 \since 5.5
Constructs a new QDateTime containing a copy of the CFDate \a date. Constructs a new QDateTime containing a copy of the CFDate \a date.
@ -377,7 +374,7 @@ QDateTime QDateTime::fromCFDate(CFDateRef date)
+ kCFAbsoluteTimeIntervalSince1970) * 1000)); + kCFAbsoluteTimeIntervalSince1970) * 1000));
} }
/*! \fn CFDateRef QDateTime::toCFDate() const /*!
\since 5.5 \since 5.5
Creates a CFDate from a QDateTime. The caller owns the CFDate object Creates a CFDate from a QDateTime. The caller owns the CFDate object
@ -391,7 +388,7 @@ CFDateRef QDateTime::toCFDate() const
/ 1000) - kCFAbsoluteTimeIntervalSince1970); / 1000) - kCFAbsoluteTimeIntervalSince1970);
} }
/*! \fn QDateTime QDateTime::fromNSDate(const NSDate *date) /*!
\since 5.5 \since 5.5
Constructs a new QDateTime containing a copy of the NSDate \a date. Constructs a new QDateTime containing a copy of the NSDate \a date.
@ -405,7 +402,7 @@ QDateTime QDateTime::fromNSDate(const NSDate *date)
return QDateTime::fromMSecsSinceEpoch(static_cast<qint64>([date timeIntervalSince1970] * 1000)); return QDateTime::fromMSecsSinceEpoch(static_cast<qint64>([date timeIntervalSince1970] * 1000));
} }
/*! \fn NSDate QDateTime::toNSDate() const /*!
\since 5.5 \since 5.5
Creates an NSDate from a QDateTime. The NSDate object is autoreleased. Creates an NSDate from a QDateTime. The NSDate object is autoreleased.