Sfoglia il codice sorgente

Docs: Missing parameter documentation for UTF8::toANSI

BearishSun 8 anni fa
parent
commit
0e1885de9b
1 ha cambiato i file con 5 aggiunte e 3 eliminazioni
  1. 5 3
      Source/BansheeUtility/String/BsUnicode.h

+ 5 - 3
Source/BansheeUtility/String/BsUnicode.h

@@ -23,9 +23,11 @@ namespace bs
 		/**
 		 * Converts from an UTF-8 encoding into ANSI encoding in the specified locale.
 		 * 
-		 * @param[in]	input	Narrow string encoded as UTF-8 characters.
-		 * @param[in]	locale	Locale that determines from which code page to generate the ANSI characters.
-		 * @return				ANSI encoded string in the specified locale.
+		 * @param[in]	input			Narrow string encoded as UTF-8 characters.
+		 * @param[in]	locale			Locale that determines from which code page to generate the ANSI characters.
+		 * @param[in]	invalidChar		Character that will be used when an Unicode character cannot be represented using
+		 *								the selected ANSI code page.
+		 * @return						ANSI encoded string in the specified locale.
 		 */
 		static String toANSI(const String& input, const std::locale& locale = std::locale(), char invalidChar = 0);