Fix some qdoc-warnings for 5.9
qtbase/src/corelib/global/qoperatingsystemversion.cpp:119: warning: Cannot find 'QOperatingSystemVersion(...)' in '\fn' QOperatingSystemVersion::QOperatingSystemVersion(int maj, int min, int mic) qtbase/src/corelib/io/qdir.cpp:1852: warning: Unknown command '\p' qtbase/src/corelib/kernel/qabstracteventdispatcher.cpp:482: warning: Cannot find 'registerEventNotifier(...)' in '\fn' bool QAbstractEventDispatcher::registerEventNotifier(QWinEventNotifier *notifier); qtbase/src/corelib/kernel/qabstracteventdispatcher.cpp:495: warning: Cannot find 'unregisterEventNotifier(...)' in '\fn' bool QAbstractEventDispatcher::unregisterEventNotifier(QWinEventNotifier *notifier); qtbase/src/corelib/global/qoperatingsystemversion.cpp:268: warning: Can't link to 'macro()' qtbase/src/corelib/global/qoperatingsystemversion.cpp:296: warning: Can't link to 'typeName()' qtbase/src/corelib/io/qdir.cpp:1845: warning: Undocumented parameter 'filters' in QDir::isEmpty() qtbase/src/corelib/kernel/qobject.cpp:1636: warning: No such parameter 'interval' in QObject::startTimer() qtbase/src/network/bearer/qnetworkconfiguration.cpp:343: warning: Undocumented parameter 'timeout' in QNetworkConfiguration::setConnectTimeout() qtbase/src/gui/kernel/qoffscreensurface.cpp:337: warning: Undocumented parameter 'handle' in QOffscreenSurface::setNativeHandle() qtbase/src/platformheaders/xcbfunctions/qxcbwindowfunctions.qdoc:109: warning: Unknown command '\role' qtbase/src/widgets/util/qundostack.cpp:727: warning: Command '\li' outside of '\list' and '\table' ... Change-Id: I57bff895a8e1afd94b582a6a72a06771514ee27e Reviewed-by: Jake Petroules <jake.petroules@qt.io>
This commit is contained in:
parent
ad5eb297e1
commit
fec5405f4d
@ -118,7 +118,7 @@ QT_BEGIN_NAMESPACE
|
||||
current >= QOperatingSystemVersion(QOperatingSystemVersion::IOS, 8)) {
|
||||
// returns true on macOS >= 10.10 and iOS >= 8.0, but false on macOS < 10.10 and iOS < 8.0
|
||||
}
|
||||
\encode
|
||||
\endcode
|
||||
|
||||
A more naive comparison algorithm might incorrectly return true on all versions of macOS,
|
||||
including Mac OS 9. This behavior is achieved by overloading the comparison operators to return
|
||||
@ -144,10 +144,10 @@ QT_BEGIN_NAMESPACE
|
||||
*/
|
||||
|
||||
/*!
|
||||
\fn QOperatingSystemVersion::QOperatingSystemVersion(int maj, int min, int mic)
|
||||
\fn QOperatingSystemVersion::QOperatingSystemVersion(OSType osType, int vmajor, int vminor = -1, int vmicro = -1)
|
||||
|
||||
Constructs a QOperatingSystemVersion consisting of the OS type \a os, and
|
||||
major, minor, and micro version numbers \a maj, \a min and \a mic, respectively.
|
||||
Constructs a QOperatingSystemVersion consisting of the OS type \a osType, and
|
||||
major, minor, and micro version numbers \a vmajor, \a vminor and \a vmicro, respectively.
|
||||
*/
|
||||
|
||||
/*!
|
||||
@ -264,7 +264,7 @@ int QOperatingSystemVersion::compare(const QOperatingSystemVersion &v1,
|
||||
|
||||
-1 indicates an unknown or absent version number component.
|
||||
|
||||
\sa majorVersion(), macro()
|
||||
\sa majorVersion(), microVersion()
|
||||
*/
|
||||
|
||||
/*!
|
||||
@ -286,7 +286,7 @@ int QOperatingSystemVersion::compare(const QOperatingSystemVersion &v1,
|
||||
|
||||
Returns the OS type identified by the QOperatingSystemVersion.
|
||||
|
||||
\sa typeName()
|
||||
\sa name()
|
||||
*/
|
||||
|
||||
/*!
|
||||
|
@ -557,6 +557,7 @@ void QDataStream::setByteOrder(ByteOrder bo)
|
||||
\value Qt_5_6 Version 17 (Qt 5.6)
|
||||
\value Qt_5_7 Same as Qt_5_6
|
||||
\value Qt_5_8 Same as Qt_5_6
|
||||
\value Qt_5_9 Same as Qt_5_6
|
||||
\omitvalue Qt_DefaultCompiledVersion
|
||||
|
||||
\sa setVersion(), version()
|
||||
|
@ -1849,7 +1849,7 @@ bool QDir::exists(const QString &name) const
|
||||
\c{QDir::AllEntries | QDir::NoDotAndDotDot}, but faster as it just checks
|
||||
whether the directory contains at least one entry.
|
||||
|
||||
\note Unless you set the \p filters flags to include \c{QDir::NoDotAndDotDot}
|
||||
\note Unless you set the \a filters flags to include \c{QDir::NoDotAndDotDot}
|
||||
(as the default value does), no directory is empty.
|
||||
|
||||
\sa count(), entryList(), setFilter()
|
||||
|
@ -95,7 +95,7 @@ public:
|
||||
|
||||
virtual int remainingTime(int timerId) = 0;
|
||||
|
||||
#ifdef Q_OS_WIN
|
||||
#if defined(Q_OS_WIN) || defined(Q_QDOC)
|
||||
virtual bool registerEventNotifier(QWinEventNotifier *notifier) = 0;
|
||||
virtual void unregisterEventNotifier(QWinEventNotifier *notifier) = 0;
|
||||
#endif
|
||||
|
@ -1642,7 +1642,7 @@ int QObject::startTimer(int interval, Qt::TimerType timerType)
|
||||
it could not start a timer.
|
||||
|
||||
A timer event will occur every \a time interval until killTimer()
|
||||
is called. If \a interval is equal to \c{std::chrono::duration::zero()},
|
||||
is called. If \a time is equal to \c{std::chrono::duration::zero()},
|
||||
then the timer event occurs once every time there are no more window
|
||||
system events to process.
|
||||
|
||||
|
@ -335,7 +335,7 @@ void QOffscreenSurface::setScreen(QScreen *newScreen)
|
||||
}
|
||||
|
||||
/*!
|
||||
Sets the native handle to which the offscreen surface is connected.
|
||||
Sets the native handle to which the offscreen surface is connected to \a handle.
|
||||
|
||||
The native handle will be resolved in the create() function. Calling
|
||||
this function after create() will not re-create a native surface.
|
||||
|
@ -343,7 +343,7 @@ int QNetworkConfiguration::connectTimeout() const
|
||||
/*!
|
||||
\since 5.9
|
||||
|
||||
Sets the connect timeout of this configuration.
|
||||
Sets the connect timeout of this configuration to \a timeout.
|
||||
This allows control of the timeout used by \c QAbstractSocket
|
||||
to establish a connection.
|
||||
|
||||
|
@ -106,7 +106,7 @@
|
||||
\fn void QXcbWindowFunctions::setWmWindowRole(QWindow *window, const QByteArray &role)
|
||||
\since 5.6.2
|
||||
|
||||
Sets the WM_WINDOW_ROLE property from \role on the corresponding
|
||||
Sets the WM_WINDOW_ROLE property from \a role on the corresponding
|
||||
X11 window.
|
||||
|
||||
This is a convenience function that can be used directly instead
|
||||
|
@ -724,10 +724,12 @@ void QUndoStack::setClean()
|
||||
This method resets the clean index to -1.
|
||||
|
||||
This is typically called in the following cases, when a document has been:
|
||||
\list
|
||||
\li created basing on some template and has not been saved,
|
||||
so no filename has been associated with the document yet.
|
||||
\li restored from a backup file.
|
||||
\li changed outside of the editor and the user did not reload it.
|
||||
\endlist
|
||||
|
||||
\sa isClean(), setClean(), cleanIndex()
|
||||
*/
|
||||
|
Loading…
x
Reference in New Issue
Block a user