Fix documentation for withCWStringLen (#5396)
authorSimon Marlow <marlowsd@gmail.com>
Thu, 25 Aug 2011 09:41:43 +0000 (10:41 +0100)
committerSimon Marlow <marlowsd@gmail.com>
Thu, 25 Aug 2011 10:12:38 +0000 (11:12 +0100)
Foreign/C/String.hs

index f369916..09dd27a 100644 (file)
@@ -484,10 +484,9 @@ newCWStringLen str  = newArrayLen (charsToCWchars str)
 withCWString :: String -> (CWString -> IO a) -> IO a
 withCWString  = withArray0 wNUL . charsToCWchars
 
--- | Marshal a Haskell string into a NUL terminated C wide string using
--- temporary storage.
---
--- * the Haskell string may /not/ contain any NUL characters
+-- | Marshal a Haskell string into a C wide string (i.e. wide
+-- character array) in temporary storage, with explicit length
+-- information.
 --
 -- * the memory is freed when the subcomputation terminates (either
 --   normally or via an exception), so the pointer to the temporary