loot/libloot
0
0
Fork 0
mirror of https://github.com/loot/libloot.git synced 2026-07-27 14:16:01 -07:00
Code Issues Packages Projects Releases Wiki Activity

Fix malformatted API documentation

Browse Source
This commit is contained in:
Oliver Hamlet
2022-02-06 18:31:42 +00:00
parent 0a27fe4844
commit 9443135dbe
1 changed files with 13 additions and 18 deletions
Download Patch File Download Diff File Expand all files Collapse all files
include/loot/metadata/message_content.h
+13 -18
View File
@@ -92,25 +92,20 @@ public:
* The MessageContent objects to choose between.
* @param language
* The locale or language code for the preferred language to select.
* Locale codes are of the form <language code>_<country code>.
* Locale codes are of the form `[language code]_[country code]`.
* @return A MessageContent object.
*
* If the vector only contains a single element, that element is
* returned.
*
* If content with a language that exactly matches the given locale
* or language code is present, that content is returned.
*
* If a locale code is given and there is no exact match but content
* for that locale's language is present, that content is returned.
*
* If a language code is given and there is no exact match but content
* for a locale in that langauge is present, that content is returned.
*
* If no locale or language code matches are found and content in the
* default language is present, that content is returned.
*
* Otherwise, an empty optional is returned.
* * If the vector only contains a single element, that element is
* returned.
* * If content with a language that exactly matches the given locale
* or language code is present, that content is returned.
* * If a locale code is given and there is no exact match but content
* for that locale's language is present, that content is returned.
* * If a language code is given and there is no exact match but
* content for a locale in that langauge is present, that content is
* returned.
* * If no locale or language code matches are found and content in
* the default language is present, that content is returned.
* * Otherwise, an empty optional is returned.
*/
LOOT_API static std::optional<MessageContent> Choose(
const std::vector<MessageContent> content,