From aa101c3147debcba3f0441c80b477782e456a03b Mon Sep 17 00:00:00 2001 From: Chris Lattner Date: Thu, 29 May 2003 15:06:40 +0000 Subject: [PATCH] Doxygenify comments git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@6393 91177308-0d34-0410-b5e6-96231b3b80d8 --- include/llvm/Transforms/Utils/Cloning.h | 31 ++++++++++++------------- 1 file changed, 15 insertions(+), 16 deletions(-) diff --git a/include/llvm/Transforms/Utils/Cloning.h b/include/llvm/Transforms/Utils/Cloning.h index a2959bb336d..7c4148445ca 100644 --- a/include/llvm/Transforms/Utils/Cloning.h +++ b/include/llvm/Transforms/Utils/Cloning.h @@ -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 &ValueMap, std::vector &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