aboutsummaryrefslogtreecommitdiffstats
path: root/src/libs
diff options
context:
space:
mode:
authorhjk <[email protected]>2023-03-24 12:07:30 +0100
committerhjk <[email protected]>2023-03-24 14:51:55 +0000
commit884a1d6f944b1334fb1350f426944993eaaf72af (patch)
treed59e899d9c1fc399fee75a3bce633b2f8a9d1203 /src/libs
parent623a7fa358d0b616d69c9ddb344ab1351970b8e2 (diff)
Replace a few \returns by Returns
Change-Id: I09c633e610421f5cc8257b15de60ffa98d890ee0 Reviewed-by: Leena Miettinen <[email protected]>
Diffstat (limited to 'src/libs')
-rw-r--r--src/libs/3rdparty/cplusplus/Symbol.h4
-rw-r--r--src/libs/qmljs/qmljsutils.cpp5
-rw-r--r--src/libs/utils/multitextcursor.h18
3 files changed, 14 insertions, 13 deletions
diff --git a/src/libs/3rdparty/cplusplus/Symbol.h b/src/libs/3rdparty/cplusplus/Symbol.h
index 497226dcc1a..dc07ced907d 100644
--- a/src/libs/3rdparty/cplusplus/Symbol.h
+++ b/src/libs/3rdparty/cplusplus/Symbol.h
@@ -66,10 +66,10 @@ public:
/// Returns this Symbol's source location.
int sourceLocation() const { return _sourceLocation; }
- /// \returns this Symbol's line number. The line number is 1-based.
+ /// Returns this Symbol's line number. The line number is 1-based.
int line() const { return _line; }
- /// \returns this Symbol's column number. The column number is 1-based.
+ /// Returns this Symbol's column number. The column number is 1-based.
int column() const { return _column; }
/// Returns this Symbol's file name.
diff --git a/src/libs/qmljs/qmljsutils.cpp b/src/libs/qmljs/qmljsutils.cpp
index 1609e49c68c..e33a6b3e809 100644
--- a/src/libs/qmljs/qmljsutils.cpp
+++ b/src/libs/qmljs/qmljsutils.cpp
@@ -115,8 +115,9 @@ SourceLocation QmlJS::fullLocationForQualifiedId(AST::UiQualifiedId *qualifiedId
}
/*!
- \returns the value of the 'id:' binding in \a object
- \param idBinding optional out parameter to get the UiScriptBinding for the id binding
+ Returns the value of the 'id:' binding in \a object.
+
+ \a idBinding is optional out parameter to get the UiScriptBinding for the id binding.
*/
QString QmlJS::idOfObject(Node *object, UiScriptBinding **idBinding)
{
diff --git a/src/libs/utils/multitextcursor.h b/src/libs/utils/multitextcursor.h
index edb4f5f1fd6..b2565f931ff 100644
--- a/src/libs/utils/multitextcursor.h
+++ b/src/libs/utils/multitextcursor.h
@@ -28,15 +28,15 @@ public:
~MultiTextCursor();
- /// replace all cursors with \param cursors and the last one will be the new main cursors
+ /// Replaces all cursors with \param cursors and the last one will be the new main cursors.
void setCursors(const QList<QTextCursor> &cursors);
const QList<QTextCursor> cursors() const;
- /// \returns whether this multi cursor contains any cursor
+ /// Returns whether this multi cursor contains any cursor.
bool isNull() const;
- /// \returns whether this multi cursor contains more than one cursor
+ /// Returns whether this multi cursor contains more than one cursor.
bool hasMultipleCursors() const;
- /// \returns the number of cursors handled by this cursor
+ /// Returns the number of cursors handled by this cursor.
int cursorCount() const;
/// the \param cursor that is appended by added by \brief addCursor
@@ -46,9 +46,9 @@ public:
/// convenience function that removes the old main cursor and appends
/// \param cursor as the new main cursor
void replaceMainCursor(const QTextCursor &cursor);
- /// \returns the main cursor
+ /// Returns the main cursor.
QTextCursor mainCursor() const;
- /// \returns the main cursor and removes it from this multi cursor
+ /// Returns the main cursor and removes it from this multi cursor.
QTextCursor takeMainCursor();
void beginEditBlock();
@@ -62,10 +62,10 @@ public:
/// with the move \param mode
void movePosition(QTextCursor::MoveOperation operation, QTextCursor::MoveMode mode, int n = 1);
- /// \returns whether any cursor has a selection
+ /// Returns whether any cursor has a selection.
bool hasSelection() const;
- /// \returns the selected text of all cursors that have a selection separated by
- /// a newline character
+ /// Returns the selected text of all cursors that have a selection separated by
+ /// a newline character.
QString selectedText() const;
/// removes the selected text of all cursors that have a selection from the document
void removeSelectedText();