summaryrefslogtreecommitdiff
path: root/libraries/base/GHC/IO/Encoding.hs
diff options
context:
space:
mode:
authorHerbert Valerio Riedel <hvr@gnu.org>2014-12-16 12:07:10 +0100
committerHerbert Valerio Riedel <hvr@gnu.org>2014-12-16 13:30:08 +0100
commit554aedab646075e12e53b44df04bcfbccbe03a73 (patch)
tree0832201a44fd74632bbbd88fb77cb6c11eb34cf7 /libraries/base/GHC/IO/Encoding.hs
parent45a9696c550c5fe5e891b6d4710179272dc9f6db (diff)
downloadhaskell-554aedab646075e12e53b44df04bcfbccbe03a73.tar.gz
Convert `/Since: .../` to new `@since ...` syntax
Starting with Haddock 2.16 there's a new built-in support for since-annotations Note: This exposes a bug in the `@since` implementation (see e.g. `Data.Bits`)
Diffstat (limited to 'libraries/base/GHC/IO/Encoding.hs')
-rw-r--r--libraries/base/GHC/IO/Encoding.hs12
1 files changed, 6 insertions, 6 deletions
diff --git a/libraries/base/GHC/IO/Encoding.hs b/libraries/base/GHC/IO/Encoding.hs
index 68bc0cfa4e..31683b4e68 100644
--- a/libraries/base/GHC/IO/Encoding.hs
+++ b/libraries/base/GHC/IO/Encoding.hs
@@ -103,7 +103,7 @@ utf32be = UTF32.utf32be
-- | The Unicode encoding of the current locale
--
--- /Since: 4.5.0.0/
+-- @since 4.5.0.0
getLocaleEncoding :: IO TextEncoding
-- | The Unicode encoding of the current locale, but allowing arbitrary
@@ -116,17 +116,17 @@ getLocaleEncoding :: IO TextEncoding
-- the use of code pages is deprecated: Strings should be retrieved
-- via the "wide" W-family of UTF-16 APIs instead
--
--- /Since: 4.5.0.0/
+-- @since 4.5.0.0
getFileSystemEncoding :: IO TextEncoding
-- | The Unicode encoding of the current locale, but where undecodable
-- bytes are replaced with their closest visual match. Used for
-- the 'CString' marshalling functions in "Foreign.C.String"
--
--- /Since: 4.5.0.0/
+-- @since 4.5.0.0
getForeignEncoding :: IO TextEncoding
--- | /Since: 4.5.0.0/
+-- | @since 4.5.0.0
setLocaleEncoding, setFileSystemEncoding, setForeignEncoding :: TextEncoding -> IO ()
(getLocaleEncoding, setLocaleEncoding) = mkGlobal initLocaleEncoding
@@ -138,7 +138,7 @@ mkGlobal x = unsafePerformIO $ do
x_ref <- newIORef x
return (readIORef x_ref, writeIORef x_ref)
--- | /Since: 4.5.0.0/
+-- | @since 4.5.0.0
initLocaleEncoding, initFileSystemEncoding, initForeignEncoding :: TextEncoding
#if !defined(mingw32_HOST_OS)
@@ -169,7 +169,7 @@ initForeignEncoding = CodePage.mkLocaleEncoding IgnoreCodingFailure
-- discards information, so encode followed by decode is not the
-- identity.
--
--- /Since: 4.4.0.0/
+-- @since 4.4.0.0
char8 :: TextEncoding
char8 = Latin1.latin1