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
This commit is contained in:
Chris Lattner 2004-11-16 06:41:21 +00:00
parent babb45b327
commit 456b97297c

View File

@ -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
);