From: Chris Lattner <sabre@nondot.org>
Date: Tue, 8 Jun 2004 06:23:17 +0000 (+0000)
Subject: Add documentation to the TargetFrameInfo class, contributed by Vladimir Prus
X-Git-Url: http://plrg.eecs.uci.edu/git/?a=commitdiff_plain;h=c07c0df634d31849ac659234e4718b57ddacb882;p=oota-llvm.git

Add documentation to the TargetFrameInfo class, contributed by Vladimir Prus


git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@14060 91177308-0d34-0410-b5e6-96231b3b80d8
---

diff --git a/include/llvm/Target/TargetFrameInfo.h b/include/llvm/Target/TargetFrameInfo.h
index bdcf7930a0f..2be5ab4857d 100644
--- a/include/llvm/Target/TargetFrameInfo.h
+++ b/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