Add documentation to the TargetFrameInfo class, contributed by Vladimir Prus

llvm-svn: 14060

1 files changed, 7 insertions, 0 deletions

diff --git a/llvm/include/llvm/Target/TargetFrameInfo.h b/llvm/include/llvm/Target/TargetFrameInfo.h
index bdcf7930a0f..2be5ab4857d 100644
--- a/llvm/include/llvm/Target/TargetFrameInfo.h
+++ b/llvm/include/llvm/Target/TargetFrameInfo.h
@@ -18,6 +18,13 @@ namespace llvm {
 
 class MachineFunction;
 
+/// Information about stack frame layout on the target.  It holds the direction
+/// of stack growth, the known stack alignment on entry to each function, and
+/// the offset to the locals area.
+///
+/// The offset to the local area is the offset from the stack pointer on
+/// function entry to the first location where function data (local variables,
+/// spill locations) can be stored.
 struct TargetFrameInfo {
   enum StackDirection {
     StackGrowsUp,        // Adding to the stack increases the stack address