diff options
author | Topi Reinio <topi.reinio@qt.io> | 2021-08-20 18:25:50 +0200 |
---|---|---|
committer | Qt Cherry-pick Bot <cherrypick_bot@qt-project.org> | 2021-08-24 22:06:15 +0000 |
commit | f0101e09d2a2d4987c5f89dcd339a02e7d3c8822 (patch) | |
tree | c91a2217143c41090ebe0cb5ef66d62c85579158 /src/corelib/time | |
parent | 1bd497675909df47e7b8bb7a7b544ad37bdc6eb1 (diff) |
Doc: Fix documentation issues for Qt Core
* Tag deprecated Q(Multi)Map operators in the header to correctly
match them with documentation \fn commands.
* Add documentation for QByteArrayView comparison operators.
* Add a dummy typedef 'jfieldID' for generating docs correctly
on non-Android platforms
* Fix other minor issues
Task-number: QTBUG-95860
Change-Id: I141d2f75d6aa10557aa374201f09ad74b4cd6e81
Reviewed-by: Paul Wicking <paul.wicking@qt.io>
(cherry picked from commit 145940e1ef8fc8334ff4603a44f7896886e646cb)
Reviewed-by: Qt Cherry-pick Bot <cherrypick_bot@qt-project.org>
Diffstat (limited to 'src/corelib/time')
-rw-r--r-- | src/corelib/time/qcalendar.cpp | 28 |
1 files changed, 14 insertions, 14 deletions
diff --git a/src/corelib/time/qcalendar.cpp b/src/corelib/time/qcalendar.cpp index 4631c9a94c..7fa64d6db3 100644 --- a/src/corelib/time/qcalendar.cpp +++ b/src/corelib/time/qcalendar.cpp @@ -82,7 +82,7 @@ inline size_t qHash(const CalendarName &key, size_t seed = 0) noexcept namespace QtPrivate { -/*! +/* \internal Handles calendar backend registration. */ @@ -179,7 +179,7 @@ public: QStringList backendNames(const QCalendarBackend *backend); }; -/*! +/* Destroy the registry. This destroys all registered backends. This destructor should only be called @@ -194,7 +194,7 @@ QCalendarRegistry::~QCalendarRegistry() qDeleteAll(byId); } -/*! +/* Registers a custom backend. A new unique ID is allocated for the \a backend. The registry takes @@ -218,7 +218,7 @@ void QCalendarRegistry::registerCustomBackend(QCalendarBackend *backend, const Q registerBackendLockHeld(backend, names, QCalendar::System::User); } -/*! +/* Ensures all system calendars have been instantiated. This arranges for each system backend to be registered. The method only @@ -248,7 +248,7 @@ void QCalendarRegistry::ensurePopulated() #endif } -/*! +/* Helper functions for system backend registration. This function must be called with write lock held on the registry. @@ -303,7 +303,7 @@ QCalendarBackend *QCalendarRegistry::registerSystemBackendLockHeld(QCalendar::Sy return backend; } -/*! +/* Helper function for backend registration. This function must be called with write lock held on the registry. @@ -350,7 +350,7 @@ void QCalendarRegistry::registerBackendLockHeld(QCalendarBackend *backend, const } } -/*! +/* Returns a list of names of the available calendar systems. Any QCalendarBackend sub-class must be registered before being exposed to Date @@ -366,7 +366,7 @@ QStringList QCalendarRegistry::availableCalendars() return QStringList(byName.keyBegin(), byName.keyEnd()); } -/*! +/* Returns a pointer to a named calendar backend. If the given \a name is present in availableCalendars(), the backend @@ -383,7 +383,7 @@ const QCalendarBackend *QCalendarRegistry::fromName(QAnyStringView name) return byName.value(name.toString(), nullptr); } -/*! +/* Returns a pointer to a calendar backend, specified by index. If a calendar with ID \a index is known to the calendar registry, the backend @@ -409,7 +409,7 @@ const QCalendarBackend *QCalendarRegistry::fromIndex(size_t index) return nullptr; } -/*! +/* Returns a pointer to a calendar backend, specified by \a system. This will instantiate the indicated calendar (which will enable fromName() @@ -442,7 +442,7 @@ const QCalendarBackend *QCalendarRegistry::fromEnum(QCalendar::System system) return registerSystemBackendLockHeld(system); } -/*! +/* Returns a list of names \a backend was registered with. */ QStringList QCalendarRegistry::backendNames(const QCalendarBackend *backend) @@ -1138,10 +1138,10 @@ const QCalendarBackend *QCalendarBackend::gregorian() */ /*! - \fn QCalendar::SystemId::isValid() + \fn QCalendar::SystemId::isValid() const - Returns true if this is a valid calendar implementation identifier, else - false. + Returns \c true if this is a valid calendar implementation identifier, + \c false otherwise. \sa QCalendar */ |