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