diff options
| author | Topi Reinio <topi.reinio@qt.io> | 2020-02-14 17:45:45 +0100 |
|---|---|---|
| committer | Topi Reinio <topi.reinio@qt.io> | 2020-02-25 19:53:27 +0100 |
| commit | 95aec76e3169d37d4d6ba908d8a96ce578cb45e2 (patch) | |
| tree | 752153d17fe1d74bd90f088731d5c7e8b048f3dd /src/corelib/time | |
| parent | 02e0c30a8aad785343ba1cddba82ccfe59099445 (diff) | |
Doc: Fix documentation warnings for Qt Core
- QCborError: Classes cannot relate to header files; use \inheaderfile
instead and link to the class from header file documentation.
- QRecursiveMutex: QDoc doesn't allow shared documentation comments
for duplicating \fn docs between the base and deriving classes.
Remove the sharing, the function documentation is available under
'All Members' doc for QRecursiveMutex.
- QMultiMap: unite() and one overload of insert() were not recognized
because their definitions in the same header file interfered with
QDoc - use Q_CLANG_QDOC macro to comment them out, and tag \fn
comments to ensure that the function documentation is matched.
Change-Id: Ic96869904a72d92453e4ffa6901000147571969b
Reviewed-by: Paul Wicking <paul.wicking@qt.io>
Diffstat (limited to 'src/corelib/time')
| -rw-r--r-- | src/corelib/time/qdatetime.cpp | 8 |
1 files changed, 3 insertions, 5 deletions
diff --git a/src/corelib/time/qdatetime.cpp b/src/corelib/time/qdatetime.cpp index 45c6ecbf23..86c08058fc 100644 --- a/src/corelib/time/qdatetime.cpp +++ b/src/corelib/time/qdatetime.cpp @@ -1127,9 +1127,7 @@ static QString toStringIsoDate(QDate date) \overload Returns the date as a string. The \a format parameter determines the format - of the string. If \a cal is supplied, it determines the calendar used to - represent the date; it defaults to Gregorian and only affects the - locale-specific formats. + of the string. If the \a format is Qt::TextDate, the string is formatted in the default way. The day and month names will be localized names using the system @@ -1236,7 +1234,7 @@ QT_WARNING_POP \fn QString QDate::toString(QStringView format, QCalendar cal) const Returns the date as a string. The \a format parameter determines the format - of the result string. If \cal is supplied, it determines the calendar used + of the result string. If \a cal is supplied, it determines the calendar used to represent the date; it defaults to Gregorian. These expressions may be used: @@ -4437,7 +4435,7 @@ QT_WARNING_POP \fn QString QDateTime::toString(QStringView format, QCalendar cal) const Returns the datetime as a string. The \a format parameter determines the - format of the result string. If \cal is supplied, it determines the calendar + format of the result string. If \a cal is supplied, it determines the calendar used to represent the date; it defaults to Gregorian. See QTime::toString() and QDate::toString() for the supported specifiers for time and date, respectively. |