From 0c385225b263b243f6db2a3ba9200cfdba9dae54 Mon Sep 17 00:00:00 2001 From: Chris Lattner Date: Tue, 8 Jun 2004 06:23:17 +0000 Subject: [PATCH] Add documentation to the TargetFrameInfo class, contributed by Vladimir Prus llvm-svn: 14060 --- include/llvm/Target/TargetFrameInfo.h | 7 +++++++ 1 file changed, 7 insertions(+) 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