summaryrefslogtreecommitdiff
path: root/src/mongo/shell/linenoise_utf8.h
diff options
context:
space:
mode:
authorMark Benvenuto <mark.benvenuto@mongodb.com>2015-06-19 10:57:36 -0400
committerMark Benvenuto <mark.benvenuto@mongodb.com>2015-06-20 10:56:04 -0400
commit6f6fa5a63d482b0dc117eb2ac21cf096deb5a6f3 (patch)
treeb76c2a4dfc7f45eb25dd62cb3ffe89ea448d9e0e /src/mongo/shell/linenoise_utf8.h
parent9c2ed42daa8fbbef4a919c21ec564e2db55e8d60 (diff)
downloadmongo-6f6fa5a63d482b0dc117eb2ac21cf096deb5a6f3.tar.gz
SERVER-18978: Clang-Format - Fix comment word wrapping indentation
Diffstat (limited to 'src/mongo/shell/linenoise_utf8.h')
-rw-r--r--src/mongo/shell/linenoise_utf8.h35
1 files changed, 21 insertions, 14 deletions
diff --git a/src/mongo/shell/linenoise_utf8.h b/src/mongo/shell/linenoise_utf8.h
index b459ea344dc..4bd4c2bdc7e 100644
--- a/src/mongo/shell/linenoise_utf8.h
+++ b/src/mongo/shell/linenoise_utf8.h
@@ -41,11 +41,11 @@ typedef unsigned int UChar32; // Unicode code point
enum BadUTF8 { BadUTF8_no_error = 0x00, BadUTF8_invalid_byte = 0x01, BadUTF8_surrogate = 0x02 };
/**
- * Convert a null terminated UTF-8 std::string from UTF-8 and store it in a UChar32 destination buffer
- * Always null terminates the destination std::string if at least one character position is available
- * Errors in the UTF-8 encoding will be handled in two ways: the erroneous characters will be
- * converted to the Unicode error character U+FFFD and flag bits will be set in the conversionErrorCode
- * int.
+ * Convert a null terminated UTF-8 std::string from UTF-8 and store it in a UChar32 destination
+ * buffer Always null terminates the destination std::string if at least one character position is
+ * available Errors in the UTF-8 encoding will be handled in two ways: the erroneous characters will
+ * be converted to the Unicode error character U+FFFD and flag bits will be set in the
+ * conversionErrorCode int.
*
* @param uchar32output Destination UChar32 buffer
* @param utf8input Source UTF-8 string
@@ -61,7 +61,8 @@ void copyString8to32(UChar32* uchar32output,
/**
* Copy a null terminated UChar32 std::string to a UChar32 destination buffer
- * Always null terminates the destination std::string if at least one character position is available
+ * Always null terminates the destination std::string if at least one character position is
+ * available
*
* @param dest32 Destination UChar32 buffer
* @param source32 Source UChar32 string
@@ -70,15 +71,17 @@ void copyString8to32(UChar32* uchar32output,
void copyString32(UChar32* dest32, const UChar32* source32, size_t destLengthInCharacters);
/**
- * Convert a specified number of UChar32 characters from a possibly null terminated UChar32 std::string to UTF-8
- * and store it in a UChar8 destination buffer
- * Always null terminates the destination std::string if at least one character position is available
+ * Convert a specified number of UChar32 characters from a possibly null terminated UChar32
+ * std::string to UTF-8 and store it in a UChar8 destination buffer
+ * Always null terminates the destination std::string if at least one character position is
+ * available
*
* @param dest8 Destination UChar8 buffer
* @param source32 Source UChar32 string
* @param outputBufferSizeInBytes Destination buffer size in bytes
* @param charCount Maximum number of UChar32 characters to process
- * @return Count of bytes written to output buffer, not including null terminator
+ * @return Count of bytes written to output buffer, not including null
+ * terminator
*/
size_t copyString32to8counted(UChar8* dest8,
const UChar32* source32,
@@ -86,13 +89,16 @@ size_t copyString32to8counted(UChar8* dest8,
size_t charCount);
/**
- * Convert a null terminated UChar32 std::string to UTF-8 and store it in a UChar8 destination buffer
- * Always null terminates the destination std::string if at least one character position is available
+ * Convert a null terminated UChar32 std::string to UTF-8 and store it in a UChar8 destination
+ * buffer
+ * Always null terminates the destination std::string if at least one character position is
+ * available
*
* @param dest8 Destination UChar8 buffer
* @param source32 Source UChar32 string
* @param outputBufferSizeInBytes Destination buffer size in bytes
- * @return Count of bytes written to output buffer, not including null terminator
+ * @return Count of bytes written to output buffer, not including null
+ * terminator
*/
size_t copyString32to8(UChar8* dest8, const UChar32* source32, size_t outputBufferSizeInBytes);
@@ -115,7 +121,8 @@ size_t strlen32(const UChar32* str32);
int strncmp32(UChar32* first32, UChar32* second32, size_t length);
/**
- * Internally convert an array of UChar32 characters of specified length to UTF-8 and write it to fileHandle
+ * Internally convert an array of UChar32 characters of specified length to UTF-8 and write it to
+ * fileHandle
*
* @param fileHandle File handle to write to
* @param string32 Source UChar32 character array, may not be null terminated