diff options
author | Shawn Rutledge <shawn.rutledge@qt.io> | 2023-03-27 11:15:27 +0200 |
---|---|---|
committer | Shawn Rutledge <shawn.rutledge@qt.io> | 2023-03-28 15:31:02 +0200 |
commit | 2a6151097e0dffc3722023b206c35d6535354096 (patch) | |
tree | b89be6139cbb973ac192bdb946d9c0163d537331 /src/qml/qml/qqmllocale.cpp | |
parent | 7cb4ccef5233d1c3c515bffc177f5f33055c9357 (diff) |
doc: Use \value rather than \li for enumeration values and constants
Pick-to: 6.2 6.5
Change-Id: Ica8354a53d0a5fb5dd1d8cd5f774dcdc56b6f99a
Reviewed-by: Paul Wicking <paul.wicking@qt.io>
Diffstat (limited to 'src/qml/qml/qqmllocale.cpp')
-rw-r--r-- | src/qml/qml/qqmllocale.cpp | 74 |
1 files changed, 33 insertions, 41 deletions
diff --git a/src/qml/qml/qqmllocale.cpp b/src/qml/qml/qqmllocale.cpp index 42e85f57af..d0025324f4 100644 --- a/src/qml/qml/qqmllocale.cpp +++ b/src/qml/qml/qqmllocale.cpp @@ -866,19 +866,17 @@ V4_DEFINE_EXTENSION(QV4LocaleDataDeletable, localeV4Data); can use the following enumeration values to specify the formatting of the string representation for a Date object. - \list - \li Locale.LongFormat The long version of day and month names; for - example, returning "January" as a month name. - \li Locale.ShortFormat The short version of day and month names; for - example, returning "Jan" as a month name. - \li Locale.NarrowFormat A special version of day and month names for - use when space is limited; for example, returning "J" as a month - name. Note that the narrow format might contain the same text for - different months and days or it can even be an empty string if the - locale doesn't support narrow names, so you should avoid using it - for date formatting. Also, for the system locale this format is - the same as ShortFormat. - \endlist + \value Locale.LongFormat The long version of day and month names; for + example, returning "January" as a month name. + \value Locale.ShortFormat The short version of day and month names; for + example, returning "Jan" as a month name. + \value Locale.NarrowFormat A special version of day and month names for + use when space is limited; for example, returning "J" as a month + name. Note that the narrow format might contain the same text for + different months and days or it can even be an empty string if the + locale doesn't support narrow names, so you should avoid using it + for date formatting. Also, for the system locale this format is + the same as ShortFormat. Additionally the double-to-string and string-to-double conversion functions are @@ -1100,15 +1098,13 @@ ReturnedValue QQmlLocale::method_localeCompare(const QV4::FunctionObject *b, con Holds the first day of the week according to the current locale. - \list - \li Locale.Sunday = 0 - \li Locale.Monday = 1 - \li Locale.Tuesday = 2 - \li Locale.Wednesday = 3 - \li Locale.Thursday = 4 - \li Locale.Friday = 5 - \li Locale.Saturday = 6 - \endlist + \value Locale.Sunday 0 + \value Locale.Monday 1 + \value Locale.Tuesday 2 + \value Locale.Wednesday 3 + \value Locale.Thursday 4 + \value Locale.Friday 5 + \value Locale.Saturday 6 \note that these values match the JS Date API which is different from the Qt C++ API where Qt::Sunday = 7. @@ -1184,10 +1180,9 @@ ReturnedValue QQmlLocale::method_localeCompare(const QV4::FunctionObject *b, con \qmlproperty enumeration QtQml::Locale::textDirection Holds the text direction of the language: - \list - \li Qt.LeftToRight - \li Qt.RightToLeft - \endlist + + \value Qt.LeftToRight Text normally begins at the left side. + \value Qt.RightToLeft Text normally begins at the right side. */ /*! @@ -1206,11 +1201,11 @@ ReturnedValue QQmlLocale::method_localeCompare(const QV4::FunctionObject *b, con \qmlmethod string QtQml::Locale::currencySymbol(format) Returns the currency symbol for the specified \a format: - \list - \li Locale.CurrencyIsoCode a ISO-4217 code of the currency. - \li Locale.CurrencySymbol a currency symbol. - \li Locale.CurrencyDisplayName a user readable name of the currency. - \endlist + + \value Locale.CurrencyIsoCode a ISO-4217 code of the currency. + \value Locale.CurrencySymbol a currency symbol. + \value Locale.CurrencyDisplayName a user readable name of the currency. + \sa Number::toLocaleCurrencyString() */ @@ -1247,16 +1242,13 @@ ReturnedValue QQmlLocale::method_localeCompare(const QV4::FunctionObject *b, con This property defines which units are used for measurement. - \list - \li Locale.MetricSystem This value indicates metric units, such as meters, - centimeters and millimeters. - \li Locale.ImperialUSSystem This value indicates imperial units, such as - inches and miles as they are used in the United States. - \li Locale.ImperialUKSystem This value indicates imperial units, such as - inches and miles as they are used in the United Kingdom. - \li Locale.ImperialSystem Provided for compatibility. The same as - Locale.ImperialUSSystem. - \endlist + \value Locale.MetricSystem This value indicates metric units, such as meters, + centimeters and millimeters. + \value Locale.ImperialUSSystem This value indicates imperial units, such as + inches and miles as they are used in the United States. + \value Locale.ImperialUKSystem This value indicates imperial units, such as + inches and miles as they are used in the United Kingdom. + \value Locale.ImperialSystem Provided for compatibility. The same as Locale.ImperialUSSystem. */ QT_END_NAMESPACE |