Doc: Fix documentation warnings

Mark documented member functions of \internal classes also as \internal
as QDoc fails to match function documentation to internal classes
otherwise.

QDoc's QML parser has trouble parsing method arguments that define
a default value. Switch to use \e instead of \a for affected
argument names.

Fixes: QTBUG-79832
Change-Id: I91c177d00d149775bd0825d5a17a0372e76e3895
Reviewed-by: Paul Wicking <paul.wicking@qt.io>

5 files changed, 15 insertions, 9 deletions

diff --git a/src/virtualkeyboard/abstractinputpanel.cpp b/src/virtualkeyboard/abstractinputpanel.cpp
index 7fbbeb55..79b17edc 100644
--- a/src/virtualkeyboard/abstractinputpanel.cpp
+++ b/src/virtualkeyboard/abstractinputpanel.cpp
@@ -79,18 +79,21 @@ AbstractInputPanel::~AbstractInputPanel()
 
 /*!
     \fn void QtVirtualKeyboard::AbstractInputPanel::show() = 0
+    \internal
 
     Shows the input panel.
 */
 
 /*!
     \fn void QtVirtualKeyboard::AbstractInputPanel::hide() = 0
+    \internal
 
     Hides the input panel.
 */
 
 /*!
     \fn bool QtVirtualKeyboard::AbstractInputPanel::isVisible() const = 0
+    \internal
 
     Returns \c true if the input panel is currently visible.
 */
@@ -114,6 +117,7 @@ void AbstractInputPanel::createView()
 
 /*!
     \fn void QtVirtualKeyboard::AbstractInputPanel::destroyView()
+    \internal
 
     Destroys the view of the input panel.
 */
diff --git a/src/virtualkeyboard/content/InputPanel.qml b/src/virtualkeyboard/content/InputPanel.qml
index b32ac340..45e0c372 100644
--- a/src/virtualkeyboard/content/InputPanel.qml
+++ b/src/virtualkeyboard/content/InputPanel.qml
@@ -83,10 +83,10 @@ Item {
         It serves as a hook to display a custom language dialog instead of
         the built-in language popup in the virtual keyboard.
 
-        The \a localeList parameter contains a list of locale names to choose
+        The \e localeList parameter contains a list of locale names to choose
         from. To get more information about a particular language, use the
-        \l {QtQml::Qt::locale()}{Qt.locale()} function. The \a currentIndex
-        is the index of current locale in the \a localeList. This item should
+        \l {QtQml::Qt::locale()}{Qt.locale()} function. The \e currentIndex
+        is the index of current locale in the \e localeList. This item should
         be highlighted as the current item in the UI.
 
         To select a new language, use the \l {VirtualKeyboardSettings::locale}
diff --git a/src/virtualkeyboard/inputmethod.cpp b/src/virtualkeyboard/inputmethod.cpp
index 45c0da97..b108be34 100644
--- a/src/virtualkeyboard/inputmethod.cpp
+++ b/src/virtualkeyboard/inputmethod.cpp
@@ -207,8 +207,9 @@ namespace QtVirtualKeyboard {
     \since QtQuick.VirtualKeyboard 2.0
 
     This method is called when the trace interaction ends. The input method should destroy the \a trace object
-    at some point after this function is called. See the \l {Trace API for Input Methods} how to access the gathered
-    data.
+    at some point after this function is called. Returns \c true on success.
+
+    See the \l {Trace API for Input Methods} how to access the gathered data.
 */
 
 /*!
diff --git a/src/virtualkeyboard/qvirtualkeyboardinputcontext.cpp b/src/virtualkeyboard/qvirtualkeyboardinputcontext.cpp
index b86492e1..fb65b29e 100644
--- a/src/virtualkeyboard/qvirtualkeyboardinputcontext.cpp
+++ b/src/virtualkeyboard/qvirtualkeyboardinputcontext.cpp
@@ -208,7 +208,7 @@ QVirtualKeyboardInputEngine *QVirtualKeyboardInputContext::inputEngine() const
 /*!
     \qmlmethod void InputContext::sendKeyClick(int key, string text, int modifiers = 0)
 
-    Sends a key click event with the given \a key, \a text and \a modifiers to
+    Sends a key click event with the given \a key, \a text and \e modifiers to
     the input item that currently has focus.
 */
 /*!
@@ -264,9 +264,9 @@ void QVirtualKeyboardInputContext::commit()
 
     Commits the final \a text to the input item and optionally
     modifies the text relative to the start of the pre-edit text.
-    If \a replaceFrom is non-zero, the \a text replaces the
-    contents relative to \a replaceFrom with a length of
-    \a replaceLength.
+    If \e replaceFrom is non-zero, the \a text replaces the
+    contents relative to \e replaceFrom with a length of
+    \e replaceLength.
 */
 /*!
     Commits the final \a text to the input item and optionally
diff --git a/src/virtualkeyboard/shifthandler.cpp b/src/virtualkeyboard/shifthandler.cpp
index 876e6229..f2118952 100644
--- a/src/virtualkeyboard/shifthandler.cpp
+++ b/src/virtualkeyboard/shifthandler.cpp
@@ -202,6 +202,7 @@ bool ShiftHandler::isUppercase() const
 */
 /*!
     \since 1.2
+    \internal
 
     \fn void QtVirtualKeyboard::ShiftHandler::toggleShift()