diff options
| author | Volker Hilsheimer <volker.hilsheimer@qt.io> | 2021-09-06 12:41:48 +0200 |
|---|---|---|
| committer | Volker Hilsheimer <volker.hilsheimer@qt.io> | 2021-09-07 15:44:19 +0200 |
| commit | 3d29a8a450a6db03ac5a9d59265471d5d50721b6 (patch) | |
| tree | 0320d6be39d7e0c5cc9d2d5fdfbc7acc6602f0b5 /src | |
| parent | 6158c27975841f6ab359fc0edb3281cabc31cbb9 (diff) | |
Doc: fix prototypes of QVirtualKeyboardDictionaryManager properties
Fix qdoc warnings. Also add parameter documentation and add see-alsos.
Pick-to: 6.2
Change-Id: I4bc7132ae028ca849d15dade7aa52ccd6b028ca2
Reviewed-by: Mitch Curtis <mitch.curtis@qt.io>
Reviewed-by: Luca Di Sera <luca.disera@qt.io>
Diffstat (limited to 'src')
| -rw-r--r-- | src/virtualkeyboard/qvirtualkeyboarddictionarymanager.cpp | 15 |
1 files changed, 10 insertions, 5 deletions
diff --git a/src/virtualkeyboard/qvirtualkeyboarddictionarymanager.cpp b/src/virtualkeyboard/qvirtualkeyboarddictionarymanager.cpp index 59904d57..0574f10e 100644 --- a/src/virtualkeyboard/qvirtualkeyboarddictionarymanager.cpp +++ b/src/virtualkeyboard/qvirtualkeyboarddictionarymanager.cpp @@ -172,6 +172,8 @@ QStringList QVirtualKeyboardDictionaryManager::activeDictionaries() const The dictionary instance is owned by the dictionary manager and must not be destroyed manually. To free memory allocated for the dictionary, the application may reset the contents of the dictionary. + + \sa dictionary() */ QVirtualKeyboardDictionary *QVirtualKeyboardDictionaryManager::createDictionary(const QString &name) @@ -189,7 +191,10 @@ QVirtualKeyboardDictionary *QVirtualKeyboardDictionaryManager::createDictionary( } /*! - Returns an existing dictionary if it exists. + Returns an existing dictionary with the given \a name if it exists, otherwise returns + \nullptr. + + \sa createDictionary() */ QVirtualKeyboardDictionary *QVirtualKeyboardDictionaryManager::dictionary(const QString &name) const @@ -200,14 +205,14 @@ QVirtualKeyboardDictionary *QVirtualKeyboardDictionaryManager::dictionary(const } /*! - \property QVirtualKeyboardDictionary::availableDictionaries + \property QVirtualKeyboardDictionaryManager::availableDictionaries \brief the list of all dictionaries. This property holds the names of all existing dictionaries. */ /*! - \property QVirtualKeyboardDictionary::baseDictionaries + \property QVirtualKeyboardDictionaryManager::baseDictionaries \brief the list of currently active base dictionaries. This property holds the names of base dictionaries. The application manages @@ -215,7 +220,7 @@ QVirtualKeyboardDictionary *QVirtualKeyboardDictionaryManager::dictionary(const */ /*! - \property QVirtualKeyboardDictionary::extraDictionaries + \property QVirtualKeyboardDictionaryManager::extraDictionaries \brief the list of currently active extra dictionaries. This property holds the names of extra dictionaries. The application manages @@ -223,7 +228,7 @@ QVirtualKeyboardDictionary *QVirtualKeyboardDictionaryManager::dictionary(const */ /*! - \property QVirtualKeyboardDictionary::activeDictionaries + \property QVirtualKeyboardDictionaryManager::activeDictionaries \brief the list of currently active dictionaries. This property holds the list of active dictionaries, which is a combination |