Doxygenify comments

git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@6393 91177308-0d34-0410-b5e6-96231b3b80d8
This commit is contained in:
Chris Lattner 2003-05-29 15:06:40 +00:00
parent 3f7b58bca0
commit aa101c3147

View File

@ -68,28 +68,27 @@ inline Function *CloneFunction(const Function *F) {
return CloneFunction(F, ValueMap);
}
// Clone OldFunc into NewFunc, transforming the old arguments into references to
// ArgMap values. Note that if NewFunc already has basic blocks, the ones
// cloned into it will be added to the end of the function. This function fills
// in a list of return instructions, and can optionally append the specified
// suffix to all values cloned.
//
/// Clone OldFunc into NewFunc, transforming the old arguments into references
/// to ArgMap values. Note that if NewFunc already has basic blocks, the ones
/// cloned into it will be added to the end of the function. This function
/// fills in a list of return instructions, and can optionally append the
/// specified suffix to all values cloned.
///
void CloneFunctionInto(Function *NewFunc, const Function *OldFunc,
std::map<const Value*, Value*> &ValueMap,
std::vector<ReturnInst*> &Returns,
const char *NameSuffix = "");
// InlineFunction - This function forcibly inlines the called function into the
// basic block of the caller. This returns true if it is not possible to inline
// this call. The program is still in a well defined state if this occurs
// though.
//
// Note that this only does one level of inlining. For example, if the
// instruction 'call B' is inlined, and 'B' calls 'C', then the call to 'C' now
// exists in the instruction stream. Similiarly this will inline a recursive
// function by one level.
//
/// InlineFunction - This function inlines the called function into the basic
/// block of the caller. This returns true if it is not possible to inline this
/// call. The program is still in a well defined state if this occurs though.
///
/// Note that this only does one level of inlining. For example, if the
/// instruction 'call B' is inlined, and 'B' calls 'C', then the call to 'C' now
/// exists in the instruction stream. Similiarly this will inline a recursive
/// function by one level.
///
bool InlineFunction(CallInst *C);
#endif