diff options
author | Topi Reinio <topi.reinio@qt.io> | 2019-01-03 13:53:58 +0100 |
---|---|---|
committer | Topi Reiniƶ <topi.reinio@qt.io> | 2019-01-04 12:19:48 +0000 |
commit | 23798415cbabfadeb76297624d5caee527ef54e2 (patch) | |
tree | 6182219d379e5328aa24f62d140e10f8125c5b1a /src | |
parent | e5884643a2ec17678abcd4c9335e00feae7233f0 (diff) |
Doc: Fix documentation issues
This commit fixes multiple documentation warnings - typos, missing
documentation, missing \internal specifiers, linking problems and
incorrect documentation configuration which caused Clang to fail
to build a precompiled header for QtVirtualKeyboard.
Change-Id: I33baf730a98747842a7813bb6ea3a3545927410b
Reviewed-by: Jarkko Koivikko <jarkko.koivikko@code-q.fi>
Reviewed-by: Martin Smith <martin.smith@qt.io>
Diffstat (limited to 'src')
9 files changed, 134 insertions, 50 deletions
diff --git a/src/virtualkeyboard/content/components/TraceInputArea.qml b/src/virtualkeyboard/content/components/TraceInputArea.qml index 10527861..40cb16f8 100644 --- a/src/virtualkeyboard/content/components/TraceInputArea.qml +++ b/src/virtualkeyboard/content/components/TraceInputArea.qml @@ -52,7 +52,7 @@ MultiPointTouchArea { /*! Pattern recognition mode of this input area. - The default value is \l {InputEngine::PatternRecognitionMode::None} {InputEngine.PatternRecognitionMode.None}. + The default value is \l {InputEngine::patternRecognitionModes} {InputEngine.PatternRecognitionMode.None}. */ property int patternRecognitionMode: InputEngine.PatternRecognitionMode.None diff --git a/src/virtualkeyboard/content/components/TraceInputKey.qml b/src/virtualkeyboard/content/components/TraceInputKey.qml index f380eb9e..dfd58ac9 100644 --- a/src/virtualkeyboard/content/components/TraceInputKey.qml +++ b/src/virtualkeyboard/content/components/TraceInputKey.qml @@ -57,7 +57,7 @@ Item { /*! Pattern recognition mode of this input area. - The default value is \l {InputEngine::PatternRecognitionMode::None} {InputEngine.PatternRecognitionMode.None}. + The default value is \l {InputEngine::patternRecognitionModes} {InputEngine.PatternRecognitionMode.None}. */ property alias patternRecognitionMode: traceInputArea.patternRecognitionMode diff --git a/src/virtualkeyboard/doc/qtvirtualkeyboard.qdocconf b/src/virtualkeyboard/doc/qtvirtualkeyboard.qdocconf index 5a61d8b5..27cec4b2 100644 --- a/src/virtualkeyboard/doc/qtvirtualkeyboard.qdocconf +++ b/src/virtualkeyboard/doc/qtvirtualkeyboard.qdocconf @@ -5,13 +5,9 @@ description = Qt Virtual Keyboard version = $QT_VERSION buildversion = Qt Virtual Keyboard | Commercial or GPLv3 -# Custom module header passed to clang -moduleheader = QtVirtualKeyboard.h - headerdirs += .. sourcedirs += .. ../../styles/ excludedirs += ../content/layouts -excludefiles += "*_p.h" # Specify the install path under QT_INSTALL_EXAMPLES exampledirs += ../../../examples/virtualkeyboard \ @@ -28,7 +24,7 @@ manifestmeta.highlighted.names = "QtVirtualKeyboard/Qt Quick Virtual Keyboard - imagedirs += images -depends += qtdoc qtcore qtgui qtwidgets qtwayland qtqml qtquick qtquickcontrols +depends += qtdoc qtcore qtgui qtwidgets qtwaylandcompositor qtqml qtquick qtquickcontrols qhp.projects = QtVirtualKeyboard diff --git a/src/virtualkeyboard/doc/src/technical-guide.qdoc b/src/virtualkeyboard/doc/src/technical-guide.qdoc index 10e0beea..9f97cbd8 100644 --- a/src/virtualkeyboard/doc/src/technical-guide.qdoc +++ b/src/virtualkeyboard/doc/src/technical-guide.qdoc @@ -452,7 +452,7 @@ from a variety of input sources (e.g. keyboard layout or full screen). The patternRecognitionModes method returns a list of pattern recognition modes, which are supported by the input method. A pattern recognition mode, such as -\l { QVirtualKeyboardInputEngine::PatternRecognitionMode::Handwriting } { HandwritingRecognition }, +\l { QVirtualKeyboardInputEngine::PatternRecognitionMode } { Handwriting }, defines the method by which the input method processes the data. The trace interaction is started when an input source detects a new contact point, and diff --git a/src/virtualkeyboard/qvirtualkeyboardabstractinputmethod.cpp b/src/virtualkeyboard/qvirtualkeyboardabstractinputmethod.cpp index 8ca0cdba..a5845a08 100644 --- a/src/virtualkeyboard/qvirtualkeyboardabstractinputmethod.cpp +++ b/src/virtualkeyboard/qvirtualkeyboardabstractinputmethod.cpp @@ -270,7 +270,7 @@ bool QVirtualKeyboardAbstractInputMethod::clickPreeditText(int cursorPosition) */ /*! - \fn bool QVirtualKeyboardAbstractInputMethod::setTextCase(QVirtualKeyboardInputEngine::::TextCase textCase) + \fn bool QVirtualKeyboardAbstractInputMethod::setTextCase(QVirtualKeyboardInputEngine::TextCase textCase) Updates the \a textCase for this input method. The method returns \c true if successful. @@ -316,7 +316,7 @@ bool QVirtualKeyboardAbstractInputMethod::clickPreeditText(int cursorPosition) /*! \fn QVariant QVirtualKeyboardAbstractInputMethod::selectionListData(QVirtualKeyboardSelectionListModel::Type type, int index, QVirtualKeyboardSelectionListModel::Role role) - Returns item data for the selection list identified by \a type. The \a \l {QVirtualKeyboardSelectionListModel::Role}{role} + Returns item data for the selection list identified by \a type. The \a role parameter specifies which data is requested. The \a index parameter is a zero based index into the list. */ diff --git a/src/virtualkeyboard/qvirtualkeyboardinputcontext.cpp b/src/virtualkeyboard/qvirtualkeyboardinputcontext.cpp index 069dfcee..16238a3b 100644 --- a/src/virtualkeyboard/qvirtualkeyboardinputcontext.cpp +++ b/src/virtualkeyboard/qvirtualkeyboardinputcontext.cpp @@ -332,24 +332,66 @@ void QVirtualKeyboardInputContext::setSelectionOnFocusObject(const QPointF &anch QPlatformInputContext::setSelectionOnFocusObject(anchorPos, cursorPos); } +/*! + \property QVirtualKeyboardInputContext::anchorRectIntersectsClipRect + \brief Holds \c true if the bounding rectangle of the selection anchor + intersects the exposed input item rectangle. + + \sa Qt::ImAnchorRectangle, Qt::ImInputItemClipRectangle +*/ +/*! + \qmlproperty bool InputContext::anchorRectIntersectsClipRect + \readonly + \brief Holds \c true if the bounding rectangle of the selection anchor + intersects the exposed input item rectangle. + + \sa Qt::ImAnchorRectangle, Qt::ImInputItemClipRectangle +*/ bool QVirtualKeyboardInputContext::anchorRectIntersectsClipRect() const { Q_D(const QVirtualKeyboardInputContext); return d->anchorRectIntersectsClipRect; } +/*! + \property QVirtualKeyboardInputContext::cursorRectIntersectsClipRect + \brief Holds \c true if the bounding rectangle of the input cursor + intersects the exposed input item rectangle. + + \sa Qt::ImCursorRectangle, Qt::ImInputItemClipRectangle +*/ +/*! + \qmlproperty bool InputContext::cursorRectIntersectsClipRect + \readonly + \brief Holds \c true if the bounding rectangle of the input cursor + intersects the exposed input item rectangle. + + \sa Qt::ImCursorRectangle, Qt::ImInputItemClipRectangle +*/ bool QVirtualKeyboardInputContext::cursorRectIntersectsClipRect() const { Q_D(const QVirtualKeyboardInputContext); return d->cursorRectIntersectsClipRect; } +/*! + \property QVirtualKeyboardInputContext::selectionControlVisible + \brief Holds \c true if the selection control is currently visible. +*/ +/*! + \qmlproperty bool InputContext::selectionControlVisible + \readonly + \brief Holds \c true if the selection control is currently visible. +*/ bool QVirtualKeyboardInputContext::isSelectionControlVisible() const { Q_D(const QVirtualKeyboardInputContext); return d->selectionControlVisible; } +/*! + \internal +*/ QVirtualKeyboardInputContextPrivate *QVirtualKeyboardInputContext::priv() const { Q_D(const QVirtualKeyboardInputContext); @@ -358,7 +400,9 @@ QVirtualKeyboardInputContextPrivate *QVirtualKeyboardInputContext::priv() const /*! \qmlproperty bool InputContext::shift - \deprecated Use \l shiftActive instead. + \deprecated + + Use \l shiftActive instead. This property is changed when the shift status changes. */ @@ -366,7 +410,9 @@ QVirtualKeyboardInputContextPrivate *QVirtualKeyboardInputContext::priv() const /*! \property QVirtualKeyboardInputContext::shift \brief the shift status. - \deprecated Use \l shiftActive instead. + \deprecated + + Use \l shiftActive instead. This property is changed when the shift status changes. */ @@ -387,7 +433,9 @@ QVirtualKeyboardInputContextPrivate *QVirtualKeyboardInputContext::priv() const /*! \qmlproperty bool InputContext::capsLock - \deprecated Use \l capsLockActive instead. + \deprecated + + Use \l capsLockActive instead. This property is changed when the caps lock status changes. */ @@ -395,7 +443,9 @@ QVirtualKeyboardInputContextPrivate *QVirtualKeyboardInputContext::priv() const /*! \property QVirtualKeyboardInputContext::capsLock \brief the caps lock status. - \deprecated Use \l capsLockActive instead. + \deprecated + + Use \l capsLockActive instead. This property is changed when the caps lock status changes. */ @@ -575,4 +625,8 @@ QVirtualKeyboardInputContextPrivate *QVirtualKeyboardInputContext::priv() const This property stores the input engine. */ +/*! + \property QVirtualKeyboardInputContext::priv + \internal +*/ QT_END_NAMESPACE diff --git a/src/virtualkeyboard/qvirtualkeyboardinputengine.cpp b/src/virtualkeyboard/qvirtualkeyboardinputengine.cpp index 45058b41..c1675507 100644 --- a/src/virtualkeyboard/qvirtualkeyboardinputengine.cpp +++ b/src/virtualkeyboard/qvirtualkeyboardinputengine.cpp @@ -850,34 +850,42 @@ void QVirtualKeyboardInputEngine::timerEvent(QTimerEvent *timerEvent) This enum specifies the input mode for the input method. - \value InputMode::Latin + \value Latin The default input mode for latin text. - \value InputMode::Numeric + \value Numeric Only numeric input is allowed. - \value InputMode::Dialable + \value Dialable Only dialable input is allowed. - \value InputMode::Pinyin + \value Pinyin Pinyin input mode for Chinese. - \value InputMode::Cangjie + \value Cangjie Cangjie input mode for Chinese. - \value InputMode::Zhuyin + \value Zhuyin Zhuyin input mode for Chinese. - \value InputMode::Hangul + \value Hangul Hangul input mode for Korean. - \value InputMode::Hiragana + \value Hiragana Hiragana input mode for Japanese. - \value InputMode::Katakana + \value Katakana Katakana input mode for Japanese. - \value InputMode::FullwidthLatin + \value FullwidthLatin Fullwidth latin input mode for East Asian languages. - \value InputMode::Greek + \value Greek Greek input mode. - \value InputMode::Cyrillic + \value Cyrillic Cyrillic input mode. - \value InputMode::Arabic + \value Arabic Arabic input mode. - \value InputMode::Hebrew + \value Hebrew Hebrew input mode. + \value ChineseHandwriting + Chinese handwriting input mode. + \value JapaneseHandwriting + Japanese handwriting input mode. + \value KoreanHandwriting + Korean handwriting input mode. + \value Thai + Thai input mode. */ /*! @@ -885,9 +893,9 @@ void QVirtualKeyboardInputEngine::timerEvent(QTimerEvent *timerEvent) This enum specifies the text case for the input method. - \value TextCase::Lower + \value Lower Lower case text. - \value TextCase::Upper + \value Upper Upper case text. */ @@ -896,13 +904,13 @@ void QVirtualKeyboardInputEngine::timerEvent(QTimerEvent *timerEvent) This enum specifies the input mode for the input method. - \value PatternRecognitionMode::None + \value None Pattern recognition is not available. - \value PatternRecognitionMode::PatternRecognitionDisabled + \value PatternRecognitionDisabled \c obsolete Use PatternRecognitionMode::None - \value PatternRecognitionMode::Handwriting + \value Handwriting Pattern recognition mode for handwriting recognition. - \value PatternRecognitionMode::HandwritingRecoginition + \value HandwritingRecoginition \c obsolete Use PatternRecognitionMode::Handwriting */ @@ -911,11 +919,11 @@ void QVirtualKeyboardInputEngine::timerEvent(QTimerEvent *timerEvent) This enum specifies the rules for word reselection. - \value ReselectFlag::WordBeforeCursor + \value WordBeforeCursor Activate the word before the cursor. When this flag is used exclusively, the word must end exactly at the cursor. - \value ReselectFlag::WordAfterCursor + \value WordAfterCursor Activate the word after the cursor. When this flag is used exclusively, the word must start exactly at the cursor. - \value ReselectFlag::WordAtCursor + \value WordAtCursor Activate the word at the cursor. This flag is a combination of the above flags with the exception that the word cannot start or stop at the cursor. */ @@ -941,6 +949,18 @@ void QVirtualKeyboardInputEngine::timerEvent(QTimerEvent *timerEvent) \since QtQuick.VirtualKeyboard 2.0 The list of available pattern recognition modes. + + Possible values: + + \value InputEngine.PatternRecognitionMode.None + Pattern recognition is not available. + \value InputEngine.PatternRecognitionMode.PatternRecognitionDisabled + \c obsolete - Use \c None instead. + \value InputEngine.PatternRecognitionMode.Handwriting + Pattern recognition mode for handwriting recognition. + \value InputEngine.PatternRecognitionMode.HandwritingRecoginition + \c obsolete - Use \c Handwriting instead. + */ /*! diff --git a/src/virtualkeyboard/qvirtualkeyboardinputengine.h b/src/virtualkeyboard/qvirtualkeyboardinputengine.h index 1a0f68d1..640d290e 100644 --- a/src/virtualkeyboard/qvirtualkeyboardinputengine.h +++ b/src/virtualkeyboard/qvirtualkeyboardinputengine.h @@ -102,7 +102,7 @@ public: WordAtCursor = WordBeforeCursor | WordAfterCursor }; Q_FLAG(ReselectFlag) - Q_DECLARE_FLAGS(ReselectFlags, QVirtualKeyboardInputEngine::ReselectFlag) + Q_DECLARE_FLAGS(ReselectFlags, ReselectFlag) public: ~QVirtualKeyboardInputEngine(); diff --git a/src/virtualkeyboard/qvirtualkeyboardselectionlistmodel.cpp b/src/virtualkeyboard/qvirtualkeyboardselectionlistmodel.cpp index bfecb978..c26d2a0b 100644 --- a/src/virtualkeyboard/qvirtualkeyboardselectionlistmodel.cpp +++ b/src/virtualkeyboard/qvirtualkeyboardselectionlistmodel.cpp @@ -105,8 +105,8 @@ public: This enum specifies the type of selection list. - \value Type::WordCandidateList - Shows list of word candidates + \value WordCandidateList + Shows list of word candidates. */ /*! @@ -114,20 +114,20 @@ public: This enum specifies a role of the data requested. - \value Role::Display + \value Display The data to be rendered in form of text. - \value Role::DisplayRole + \value DisplayRole \c obsolete Use Role::Display. - \value Role::WordCompletionLength + \value WordCompletionLength An integer specifying the length of the word the completion part expressed as the number of characters counted from the end of the string. - \value Role::WordCompletionLengthRole + \value WordCompletionLengthRole \c obsolete Use Role::WordCompletionLength. - \value Role::Dictionary + \value Dictionary An integer specifying \ l {QVirtualKeyboardSelectionListModel::DictionaryType}{dictionary type}. - \value Role::CanRemoveSuggestion + \value CanRemoveSuggestion A boolean value indicating if the word candidate can be removed from the dictionary. */ @@ -137,9 +137,9 @@ public: This enum specifies the dictionary type of a word. - \value DictionaryType::Default + \value Default The word candidate is from the default dictionary. - \value DictionaryType::User + \value User The word candidate is from the user dictionary. */ @@ -221,6 +221,10 @@ QHash<int,QByteArray> QVirtualKeyboardSelectionListModel::roleNames() const } /*! + \property QVirtualKeyboardSelectionListModel::count + \internal +*/ +/* \internal */ int QVirtualKeyboardSelectionListModel::count() const @@ -236,8 +240,6 @@ int QVirtualKeyboardSelectionListModel::count() const The selection is forwarded to the input method for further processing. */ /*! - \fn void QVirtualKeyboardSelectionListModel::selectItem(int index) - This method should be called when the user selects an item at position \a index from the list. The selection is forwarded to the input method for further processing. @@ -251,6 +253,18 @@ void QVirtualKeyboardSelectionListModel::selectItem(int index) } } +/*! + \qmlmethod void SelectionListModel::removeItem(int index) + + This method should be called when the user removes an item at position + \a index from the list. + The removal is forwarded to the input method for further processing. +*/ +/*! + This method should be called when the user removes an item at position + \a index from the list. + The removal is forwarded to the input method for further processing. +*/ void QVirtualKeyboardSelectionListModel::removeItem(int index) { Q_D(QVirtualKeyboardSelectionListModel); |