Katana_mirror/kdelibs
1
0
Fork 0
mirror of https://bitbucket.org/smil3y/kdelibs.git synced 2025-02-23 18:32:49 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

kdecore: add warning for KCharsets::descriptionForEncoding()

Browse source 
Signed-off-by: Ivailo Monev <xakepa10@gmail.com>
This commit is contained in:
Ivailo Monev 2021-07-12 13:22:31 +03:00
parent a020c03b73
commit 5cb7dfae3c
1 changed files with 7 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
kdecore/localization/kcharsets.h
View file

@ -132,7 +132,9 @@ public:
/**
* Lists the available encoding names grouped by script (or language that uses them).
* @returns the list of lists consisting of description followed by encoding names (i.e. encodingsByScript().at(i).at(0) is a description for encodingsByScript().at(i).at(k), k>0)
* @returns the list of lists consisting of description followed by encoding names
* (i.e. encodingsByScript().at(i).at(0) is a description for
* encodingsByScript().at(i).at(k), k>0)
*/
QList<QStringList> encodingsByScript() const;
@ -140,6 +142,10 @@ public:
* @brief Returns a long description for an encoding name.
* @param encoding the encoding for the language
* @return the long description for the encoding
*
* @warning some encodings returned by @p descriptiveEncodingNames() and @p encodingsByScript()
* may be regrouped with different description, do not rely on the return value for comparison.
* compare the encoding name (as returned by @p encodingForName()) instead
*/
QString descriptionForEncoding( const QString& encoding ) const;