RPCS3/llvm-mirror
1
0
Fork 0
mirror of https://github.com/RPCS3/llvm-mirror.git synced 2024-12-26 13:36:28 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Improve documentation on throwing, it is not complete still though. :(

Browse Source 
llvm-svn: 28294
This commit is contained in:
Chris Lattner 2006-05-14 19:07:07 +00:00
parent 05311325f1
commit 96c4ae0fa3
1 changed files with 3 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
include/llvm/Support/Compressor.h
View File

@ -57,6 +57,7 @@ namespace llvm {
/// writing when this method is called. The stream will not be closed by
/// this method. The \p hint argument indicates which type of
/// compression the caller would *prefer*.
/// @throws std::string explaining error if a compression error occurs
/// @returns The amount of data written to \p out.
/// @brief Compress memory to a file.
static size_t compressToStream(
@ -68,6 +69,7 @@ namespace llvm {
/// This method decompresses a block of memory pointed to by \p in with
/// size \p size to a new block of memory, \p out, \p that was allocated
/// by malloc. It is the caller's responsibility to free \p out.
/// @throws std::string explaining error if a decompression error occurs
/// @returns The size of the output buffer \p out.
/// @brief Decompress memory to a new memory buffer.
static size_t decompressToNewBuffer(
@ -80,6 +82,7 @@ namespace llvm {
/// size \p size to a stream. The stream \p out must be open and ready for
/// writing when this method is called. The stream will not be closed by
/// this method.
/// @throws std::string explaining error if a decompression error occurs
/// @returns The amount of data written to \p out.
/// @brief Decompress memory to a stream.
static size_t decompressToStream(