[llvm-commits] CVS: llvm/include/llvm/CodeGen/MachineFunction.h

[Misha Brukman]

Changes in directory llvm/include/llvm/CodeGen:

MachineFunction.h updated: 1.35 -> 1.36

---
Log message:

Clarify documentation and use correct doxygen comment form /// vs. // .
Thanks to Vladimir Prus for corrections.


---
Diffs of the changes:  (+11 -8)

Index: llvm/include/llvm/CodeGen/MachineFunction.h
diff -u llvm/include/llvm/CodeGen/MachineFunction.h:1.35 llvm/include/llvm/CodeGen/MachineFunction.h:1.36
--- llvm/include/llvm/CodeGen/MachineFunction.h:1.35	Mon May 24 02:14:35 2004
+++ llvm/include/llvm/CodeGen/MachineFunction.h	Fri Jun  4 09:51:25 2004
@@ -132,16 +132,19 @@
   ///
   void dump() const;
 
-  // The next three methods are used to construct, destruct, and retrieve the
-  // MachineFunction object for the given method.
-  //
-  // construct() -- Allocates and initializes for a given method and target
-  // get()       -- Returns a handle to the object.
-  //                This should not be called before "construct()"
-  //                for a given Method.
-  // 
+  /// construct - Allocate and initialize a MachineFunction for a given Function
+  /// and Target
+  ///
   static MachineFunction& construct(const Function *F, const TargetMachine &TM);
+
+  /// destruct - Destroy the MachineFunction corresponding to a given Function
+  ///
   static void destruct(const Function *F);
+
+  /// get - Return a handle to a MachineFunction corresponding to the given
+  /// Function.  This should not be called before "construct()" for a given
+  /// Function.
+  ///
   static MachineFunction& get(const Function *F);
 
   // Provide accessors for the MachineBasicBlock list...