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
This commit is contained in:
Chris Lattner 2004-06-08 06:23:17 +00:00
parent 96684ef886
commit c07c0df634

View File

@ -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