From 9443135dbeca3abc0fb5177f2cc4c43e07363a18 Mon Sep 17 00:00:00 2001 From: Oliver Hamlet Date: Sun, 6 Feb 2022 16:51:47 +0000 Subject: [PATCH] Fix malformatted API documentation --- include/loot/metadata/message_content.h | 31 +++++++++++-------------- 1 file changed, 13 insertions(+), 18 deletions(-) diff --git a/include/loot/metadata/message_content.h b/include/loot/metadata/message_content.h index 62a502f3..a91c922b 100644 --- a/include/loot/metadata/message_content.h +++ b/include/loot/metadata/message_content.h @@ -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 _. + * 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 Choose( const std::vector content,