summaryrefslogtreecommitdiffstats
path: root/src/corelib/global
diff options
context:
space:
mode:
authorEdward Welbourne <edward.welbourne@qt.io>2019-11-06 16:54:49 +0100
committerVolker Hilsheimer <volker.hilsheimer@qt.io>2020-05-20 05:58:19 +0200
commit96f5da22502f111f5c71e4a7aac1a564613239ea (patch)
treeb410590dd91f7e1c92c571f1a31af917bdabff44 /src/corelib/global
parent204499296c27293f1372590e9df349b192a3b32e (diff)
Fix minor errors in ISODate and RFC2822Date formats' documentation
Various format characters are not capitalized in the format string, so should not be capitalized in the doc that describes them - especially, the m for minute should not be made to coincide with the M for month. The H for hours *is* capitalized for ISODate, correctly indicating that it's on a 24-hour clock, so make that explicit; and correct the RFC2822Date doc to use HH rather than hh for its hours, likewise. Reflow to our standard 80-column limit for docs. Change-Id: I357252817d59436de5806f45d40030b873ca3926 Reviewed-by: Paul Wicking <paul.wicking@qt.io> (cherry picked from commit 6e63d65e5aa73f10b0e36e44f214f274a5ab079f) Reviewed-by: Volker Hilsheimer <volker.hilsheimer@qt.io>
Diffstat (limited to 'src/corelib/global')
-rw-r--r--src/corelib/global/qnamespace.qdoc23
1 files changed, 13 insertions, 10 deletions
diff --git a/src/corelib/global/qnamespace.qdoc b/src/corelib/global/qnamespace.qdoc
index 2fe019f372..dc49d87cf3 100644
--- a/src/corelib/global/qnamespace.qdoc
+++ b/src/corelib/global/qnamespace.qdoc
@@ -743,22 +743,25 @@
removed in Qt 6.} It is equivalent to SystemLocaleShortDate.
\value RFC2822Date \l{RFC 2822}, \l{RFC 850} and \l{RFC 1036} format:
- either \c{[ddd,] dd MMM yyyy [hh:mm[:ss]][ ±tzoff]}
- or \c{ddd MMM dd[ hh:mm:ss] yyyy[ ±tzoff]} are recognized for combined dates
- and times, where \c{tzoff} is a timezone offset in \c{hhmm} format. For
+ either \c{[ddd,] dd MMM yyyy [HH:mm[:ss]][ ±tzoff]}
+ or \c{ddd MMM dd[ HH:mm:ss] yyyy[ ±tzoff]} are recognized for combined dates
+ and times, where \c{tzoff} is a timezone offset in \c{HHmm} format. For
dates and times separately, the same formats are matched and the unwanted
parts are ignored. In particular, note that a time is not recognized without
an accompanying date. When converting dates to string form,
- format \c{dd MMM yyyy} is used, for times the format is \c{hh:mm:ss}. For
+ format \c{dd MMM yyyy} is used, for times the format is \c{HH:mm:ss}. For
combined date and time, these are combined
- as \c{dd MMM yyyy hh:mm:ss ±tzoff} (omitting the optional leading day of the
+ as \c{dd MMM yyyy HH:mm:ss ±tzoff} (omitting the optional leading day of the
week from the first format recognized).
- \note For \c ISODate formats, each \c Y, \c M and \c D represents a single digit
- of the year, month and day used to specify the date. Each \c H, \c M and \c S
- represents a single digit of the hour, minute and second used to specify the time.
- The presence of a literal \c T character is used to separate the date and time when
- both are specified.
+ \note For \c ISODate formats, each \c y, \c M and \c d represents a single
+ digit of the year, month, and day used to specify the date. Each \c H, \c m,
+ and \c s represents a single digit of the hour (up to 24), minute and second
+ used to specify the time. The presence of a literal \c T character is used
+ to separate the date and time when both are specified. For the \c
+ RFC2822Date format, MMM stands for the first three letters of the month name
+ in English, the other format characters have the same meaning as for the
+ ISODate format.
*/