Skip to content

Commit

Permalink
Doc: Correct non-link related qdoc compilation errors
Browse files Browse the repository at this point in the history
Task-number: QTBUG-79824
Change-Id: I94dc566c9fb11bc8c598c0d5c043b6f388ebdc80
Reviewed-by: Paul Wicking <[email protected]>
  • Loading branch information
vertrni authored and paulwicking committed Jan 14, 2020
1 parent 8298118 commit 7a59d6f
Show file tree
Hide file tree
Showing 9 changed files with 23 additions and 12 deletions.
4 changes: 3 additions & 1 deletion src/corelib/io/qprocess.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -1004,7 +1004,7 @@ QT_WARNING_POP

/*!
\internal
Returns true if we emitted readyRead().
Returns \c true if we emitted readyRead().
*/
bool QProcessPrivate::tryReadFromChannel(Channel *channel)
{
Expand Down Expand Up @@ -2187,6 +2187,8 @@ bool QProcess::startDetached(qint64 *pid)
This method is an alias for start(), and exists only to fully implement
the interface defined by QIODevice.
Returns \c true if the program has been started.
\sa start(), setProgram(), setArguments()
*/
bool QProcess::open(OpenMode mode)
Expand Down
5 changes: 5 additions & 0 deletions src/corelib/itemmodels/qstringlistmodel.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -212,6 +212,7 @@ Qt::ItemFlags QStringListModel::flags(const QModelIndex &index) const
\a index in the model, to the provided \a value.
The dataChanged() signal is emitted if the item is changed.
Returns \c true after emitting the dataChanged() signal.
\sa Qt::ItemDataRole, data()
*/
Expand Down Expand Up @@ -249,6 +250,8 @@ bool QStringListModel::clearItemData(const QModelIndex &index)
specified, indicating that the rows are inserted in the top level of
the model.
Returns \c true if the insertion was successful.
\sa QAbstractItemModel::insertRows()
*/

Expand All @@ -275,6 +278,8 @@ bool QStringListModel::insertRows(int row, int count, const QModelIndex &parent)
specified, indicating that the rows are removed in the top level of
the model.
Returns \c true if the row removal was successful.
\sa QAbstractItemModel::removeRows()
*/

Expand Down
2 changes: 1 addition & 1 deletion src/corelib/tools/qline.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -374,7 +374,7 @@ QDataStream &operator>>(QDataStream &stream, QLine &line)
*/

/*!
\enum QLineF::IntersectionType
\enum QLineF::IntersectType
Describes the intersection between two lines.
Expand Down
8 changes: 4 additions & 4 deletions src/corelib/tools/qscopeguard.qdoc
Original file line number Diff line number Diff line change
Expand Up @@ -51,10 +51,10 @@ QT_BEGIN_NAMESPACE
of the scope.
\ingroup misc

QScopeGuard<F> is a class which sole purpose is to run a function \e F in
its destructor. This is useful for guaranteeing your cleanup code is
executed, whether the function is exited normally, exited early by a return
statement, or exited by an exception.
QScopeGuard<F> is a class of which the sole purpose is to run the function
\a f in its destructor. This is useful for guaranteeing
your cleanup code is executed, whether the function is exited normally,
exited early by a return statement, or exited by an exception.

If \e F is a lambda then you cannot instantiate the template directly,
therefore the qScopeGuard() helper is provided and QScopeGuard<F> is made a
Expand Down
2 changes: 2 additions & 0 deletions src/corelib/tools/qsharedpointer.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -1285,6 +1285,8 @@
\relates QSharedPointer
\since 5.14
Returns a shared pointer to the pointer held by \a src.
Same as qSharedPointerObjectCast(). This function is provided for STL
compatibility.
*/
Expand Down
6 changes: 3 additions & 3 deletions src/testlib/qsignalspy.qdoc
Original file line number Diff line number Diff line change
Expand Up @@ -102,9 +102,9 @@
\since 5.14

Constructs a new QSignalSpy that listens for emissions of the \a signal
from the QObject \a object. If QSignalSpy is not able to listen for a
valid signal (for example, because \a object is \nullptr or \a signal does
not denote a valid signal of \a object), an explanatory warning message
from the QObject \a obj. If QSignalSpy is not able to listen for a
valid signal (for example, because \a obj is \nullptr or \a signal does
not denote a valid signal of \a obj), an explanatory warning message
will be output using qWarning() and subsequent calls to \c isValid() will
return false.

Expand Down
3 changes: 2 additions & 1 deletion src/widgets/dialogs/qfiledialog.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -2374,7 +2374,8 @@ QList<QUrl> QFileDialog::getOpenFileUrls(QWidget *parent,
This function is used to access local files on Qt for WebAssembly, where the web
sandbox places restrictions on how such access may happen. Its implementation will
make the browser display a native file dialog, where the user makes the file selection.
make the browser display a native file dialog, where the user makes the file selection
based on the parameter \a nameFilter.
It can also be used on other platforms, where it will fall back to using QFileDialog.
Expand Down
3 changes: 2 additions & 1 deletion src/widgets/dialogs/qfilesystemmodel.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -1214,7 +1214,8 @@ QMimeData *QFileSystemModel::mimeData(const QModelIndexList &indexes) const
/*!
Handles the \a data supplied by a drag and drop operation that ended with
the given \a action over the row in the model specified by the \a row and
\a column and by the \a parent index.
\a column and by the \a parent index. Returns true if the operation was
successful.
\sa supportedDropActions()
*/
Expand Down
2 changes: 1 addition & 1 deletion src/widgets/kernel/qshortcut.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -475,7 +475,7 @@ QShortcut::QShortcut(QWidget *parent)
match the \a key sequence. Depending on the ambiguity of the
event, the shortcut will call the \a member function, or the \a
ambiguousMember function, if the key press was in the shortcut's
\a shortcutContext.
\a context.
*/
QShortcut::QShortcut(const QKeySequence &key, QWidget *parent,
const char *member, const char *ambiguousMember,
Expand Down

0 comments on commit 7a59d6f

Please sign in to comment.