diff options
author | Chris Lattner <sabre@nondot.org> | 2004-11-16 06:41:21 +0000 |
---|---|---|
committer | Chris Lattner <sabre@nondot.org> | 2004-11-16 06:41:21 +0000 |
commit | 456b97297c62593db98decb78054e40622200ec2 (patch) | |
tree | e37f506cb1cfe4d2c97dd72fb8a400df0d92c894 /include/llvm/Linker.h | |
parent | babb45b3277e0d85358d19d6618818a9cef561a3 (diff) | |
download | llvm-456b97297c62593db98decb78054e40622200ec2.tar.gz llvm-456b97297c62593db98decb78054e40622200ec2.tar.bz2 llvm-456b97297c62593db98decb78054e40622200ec2.tar.xz |
Document this as clobbering the second arg, make the second arg be non-const
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@17879 91177308-0d34-0410-b5e6-96231b3b80d8
Diffstat (limited to 'include/llvm/Linker.h')
-rw-r--r-- | include/llvm/Linker.h | 12 |
1 files changed, 7 insertions, 5 deletions
diff --git a/include/llvm/Linker.h b/include/llvm/Linker.h index a7a07812c3..4bb69ae419 100644 --- a/include/llvm/Linker.h +++ b/include/llvm/Linker.h @@ -22,15 +22,17 @@ namespace llvm { class Module; -/// This is the heart of the linker. The \p Src module is linked into the -/// \p Dest module. If an error occurs, true is returned, otherwise false. If -/// \p ErrorMsg is not null and an error occurs, \p *ErrorMsg will be set to a -/// readable string that indicates the nature of the error. +/// This is the heart of the linker. The \p Src module is linked into the \p +/// Dest module. If an error occurs, true is returned, otherwise false. If \p +/// ErrorMsg is not null and an error occurs, \p *ErrorMsg will be set to a +/// readable string that indicates the nature of the error. Note that this can +/// destroy the Src module in arbitrary ways. +/// /// @returns true if there's an error /// @brief Link two modules together bool LinkModules( Module* Dest, ///< Module into which \p Src is linked - const Module* Src, ///< Module linked into \p Dest + Module* Src, ///< Module linked into \p Dest std::string* ErrorMsg ///< Optional error message string ); |