Update comments

JuliaLang · Jul 12, 2015 · e8b0ba8 · e8b0ba8
1 parent ca87916
commit e8b0ba8
Show file tree

Hide file tree

Showing 5 changed files with 61 additions and 58 deletions.
diff --git a/base/unicode/checkstring.jl b/base/unicode/checkstring.jl
@@ -23,7 +23,7 @@ const UTF_SURROGATE = 32        ##< surrogate pairs present
     (ch << 6) | (byt & 0x3f)
 end
 
-"
+"""
 Validates and calculates number of characters in a UTF-8,UTF-16 or UTF-32 encoded vector/string
 
 Warning: this function does not check the bounds of the start or end positions
@@ -46,7 +46,7 @@ Use `checkstring` to make sure the bounds are checked
 
 ### Throws:
 * `UnicodeError`
-"
+"""
 function unsafe_checkstring end
 
 function unsafe_checkstring(dat::Vector{UInt8},
@@ -191,7 +191,7 @@ function unsafe_checkstring{T <: Union{Vector{UInt16}, Vector{UInt32}, AbstractS
     return totalchar, flags, num4byte, num3byte, num2byte
 end
 
-"
+"""
 Validates and calculates number of characters in a UTF-8,UTF-16 or UTF-32 encoded vector/string
 
 This function checks the bounds of the start and end positions
@@ -214,7 +214,7 @@ Use `unsafe_checkstring` to avoid that overhead if the bounds have already been
 
 ### Throws:
 * `UnicodeError`
-"
+"""
 function checkstring end
 
 # No need to check bounds if using defaults

diff --git a/base/unicode/utf16.jl b/base/unicode/utf16.jl
@@ -101,15 +101,15 @@ function isvalid(::Type{UTF16String}, data::AbstractArray{UInt16})
     return i > n || !is_surrogate_codeunit(data[i])
 end
 
-"
+"""
 Converts an `AbstractString` to a `UTF16String`
 
 ### Returns:
 *   `UTF16String`
 
 ### Throws:
 *   `UnicodeError`
-"
+"""
 function convert(::Type{UTF16String}, str::AbstractString)
     len, flags, num4byte = unsafe_checkstring(str)
     buf = Vector{UInt16}(len+num4byte+1)
@@ -128,15 +128,15 @@ function convert(::Type{UTF16String}, str::AbstractString)
     UTF16String(buf)
 end
 
-"
+"""
 Converts a `UTF8String` to a `UTF16String`
 
 ### Returns:
 *   `UTF16String`
 
 ### Throws:
 *   `UnicodeError`
-"
+"""
 function convert(::Type{UTF16String}, str::UTF8String)
     dat = str.data
     # handle zero length string quickly
@@ -174,15 +174,15 @@ function convert(::Type{UTF16String}, str::UTF8String)
     UTF16String(buf)
 end
 
-"
+"""
 Converts a `UTF16String` to a `UTF8String`
 
 ### Returns:
 *   `UTF8String`
 
 ### Throws:
 *   `UnicodeError`
-"
+"""
 function convert(::Type{UTF8String}, str::UTF16String)
     dat = str.data
     len = sizeof(dat) >>> 1
@@ -194,15 +194,15 @@ function convert(::Type{UTF8String}, str::UTF16String)
     return encode_to_utf8(UInt16, dat, len + num2byte + num3byte*2 + num4byte*3)
 end
 
-"
+"""
 Converts a vector of `Char` to a `UTF16String`
 
 ### Returns:
 *   `::UTF16String`
 
 ### Throws:
 *   `UnicodeError`
-"
+"""
 function convert(::Type{UTF16String}, chrs::Vector{Char})
     len = sizeof(chrs)
     # handle zero length string quickly
@@ -216,7 +216,7 @@ function convert(::Type{UTF16String}, chrs::Vector{Char})
     return encode_to_utf16(dat, len)
 end
 
-"
+"""
 Converts an already validated UTF-32 encoded vector of `UInt32` to a `UTF16String`
 
 ### Input Arguments:
@@ -225,7 +225,7 @@ Converts an already validated UTF-32 encoded vector of `UInt32` to a `UTF16Strin
 
 ### Returns:
 *   `::UTF16String`
-"
+"""
 function encode_to_utf16(dat, len)
     buf = Vector{UInt16}(len)
     @inbounds buf[len] = 0 # NULL termination

diff --git a/base/unicode/utf32.jl b/base/unicode/utf32.jl
@@ -15,15 +15,15 @@ utf32(x) = convert(UTF32String, x)
 convert(::Type{UTF32String}, c::Char) = UTF32String(Char[c, Char(0)])
 convert(::Type{UTF32String}, s::UTF32String) = s
 
-"
+"""
 Converts an `AbstractString` to a `UTF32String`
 
 ### Returns:
 *   `UTF32String`
 
 ### Throws:
 *   `UnicodeError`
-"
+"""
 function convert(::Type{UTF32String}, str::AbstractString)
     len, flags = unsafe_checkstring(str)
     buf = Vector{Char}(len+1)
@@ -33,15 +33,15 @@ function convert(::Type{UTF32String}, str::AbstractString)
     UTF32String(buf)
 end
 
-"
+"""
 Converts a `UTF32String` to a `UTF8String`
 
 ### Returns:
 *   `UTF8String`
 
 ### Throws:
 *   `UnicodeError`
-"
+"""
 function convert(::Type{UTF8String},  str::UTF32String)
     dat = reinterpret(UInt32, str.data)
     len = sizeof(dat) >>> 2
@@ -53,15 +53,15 @@ function convert(::Type{UTF8String},  str::UTF32String)
     return encode_to_utf8(UInt32, dat, len + num2byte + num3byte*2 + num4byte*3)
 end
 
-"
+"""
 Converts a `UTF8String` to a `UTF32String`
 
 ### Returns:
 *   `::UTF32String`
 
 ### Throws:
 *   `UnicodeError`
-"
+"""
 function convert(::Type{UTF32String}, str::UTF8String)
     dat = str.data
     # handle zero length string quickly
@@ -107,15 +107,15 @@ function convert(::Type{UTF32String}, str::UTF8String)
     UTF32String(buf)
 end
 
-"
+"""
 Converts a `UTF16String` to `UTF32String`
 
 ### Returns:
 *   `::UTF32String`
 
 ### Throws:
 *   `UnicodeError`
-"
+"""
 function convert(::Type{UTF32String}, str::UTF16String)
     dat = str.data
     len = sizeof(dat)
@@ -138,15 +138,15 @@ function convert(::Type{UTF32String}, str::UTF16String)
     UTF32String(buf)
 end
 
-"
+"""
 Converts a `UTF32String` to `UTF16String`
 
 ### Returns:
 *   `::UTF16String`
 
 ### Throws:
 *   `UnicodeError`
-"
+"""
 function convert(::Type{UTF16String}, str::UTF32String)
     dat = reinterpret(UInt32, str.data)
     len = sizeof(dat)

diff --git a/base/unicode/utf8.jl b/base/unicode/utf8.jl
@@ -217,15 +217,15 @@ utf8(x) = convert(UTF8String, x)
 convert(::Type{UTF8String}, s::UTF8String) = s
 convert(::Type{UTF8String}, s::ASCIIString) = UTF8String(s.data)
 
-"
+"""
 Converts a UTF-8 encoded vector of `UInt8` to a `UTF8String`
 
 ### Returns:
 *   `UTF8String`
 
 ### Throws:
 *   `UnicodeError`
-"
+"""
 function convert(::Type{UTF8String}, dat::Vector{UInt8})
     # handle zero length string quickly
     isempty(dat) && return empty_utf8
@@ -302,15 +302,15 @@ function convert(::Type{UTF8String}, a::Vector{UInt8}, invalids_as::AbstractStri
 end
 convert(::Type{UTF8String}, s::AbstractString) = utf8(bytestring(s))
 
-"
+"""
 Converts a vector of `Char` to a `UTF8String`
 
 ### Returns:
 *   `UTF8String`
 
 ### Throws:
 *   `UnicodeError`
-"
+"""
 function convert(::Type{UTF8String}, chrs::Vector{Char})
     len = sizeof(chrs)
     # handle zero length string quickly
@@ -322,7 +322,7 @@ function convert(::Type{UTF8String}, chrs::Vector{Char})
     return encode_to_utf8(UInt32, dat, len + num2byte + num3byte*2 + num4byte*3)
 end
 
-"
+"""
 Converts an already validated vector of `UInt16` or `UInt32` to a `UTF8String`
 
 ### Input Arguments:
@@ -331,7 +331,7 @@ Converts an already validated vector of `UInt16` or `UInt32` to a `UTF8String`
 
 ### Returns:
 * `UTF8String`
-"
+"""
 function encode_to_utf8{T<:Union{UInt16, UInt32}}(::Type{T}, dat, len)
     buf = Vector{UInt8}(len)
     out = 0