diff options
| author | Topi Reinio <topi.reinio@qt.io> | 2019-11-08 23:01:10 +0100 |
|---|---|---|
| committer | Topi Reiniö <topi.reinio@qt.io> | 2019-11-11 09:44:00 +0000 |
| commit | d4dc8988c5cfc6e0080e9ef17f8393a6a06cbb98 (patch) | |
| tree | 134a9a95027714d39674d023c277fadc5d19a6ea | |
| parent | 09fa8225d525b12ba22234a59452decaf987fb8a (diff) | |
Doc: Fix documentation warnings
The header file for QWinOverlappedIoNotifier is not available when building
on non-Windows platform - as the class is \internal anyway, suppress
the Clang-parser warnings by marking also the member functions as
\internal.
Remove a link to example file page terminal/console.cpp, as QDoc
no longer treats these files as linkable targets.
Fixes: QTBUG-79809
Change-Id: Ic3bc33c1c27bc234513fe6977877116ed16c22eb
Reviewed-by: Paul Wicking <paul.wicking@qt.io>
| -rw-r--r-- | examples/serialport/doc/terminal.qdoc | 2 | ||||
| -rw-r--r-- | src/serialport/qwinoverlappedionotifier.cpp | 2 |
2 files changed, 3 insertions, 1 deletions
diff --git a/examples/serialport/doc/terminal.qdoc b/examples/serialport/doc/terminal.qdoc index 65cabb92..02156775 100644 --- a/examples/serialport/doc/terminal.qdoc +++ b/examples/serialport/doc/terminal.qdoc @@ -122,7 +122,7 @@ \snippet terminal/mainwindow.cpp 6 This slot sends the characters typed in the given - \l{terminal/console.cpp}{Console} widget to the serial port. + Console widget to the serial port - see \c terminal/console.cpp. When the serial port receives new data, the signal \l{QIODevice::}{readyRead()} is emitted, and that signal is diff --git a/src/serialport/qwinoverlappedionotifier.cpp b/src/serialport/qwinoverlappedionotifier.cpp index 615dacc9..f29bae0a 100644 --- a/src/serialport/qwinoverlappedionotifier.cpp +++ b/src/serialport/qwinoverlappedionotifier.cpp @@ -350,6 +350,7 @@ private: }; /*! + * \internal * Wait synchronously for any notified signal. * * The function returns a pointer to the OVERLAPPED object corresponding to the completed I/O @@ -365,6 +366,7 @@ OVERLAPPED *QWinOverlappedIoNotifier::waitForAnyNotified(QDeadlineTimer deadline } /*! + * \internal * Wait synchronously for the notified signal. * * The function returns true if the notified signal was emitted for |