[LLVMdev] MachineFunction::create docs

Vladimir Prus ghost at cs.msu.su
Fri Jun 4 05:25:01 PDT 2004


The docs for MachineFunction::create method have a couple of nits:

  // 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.
  // 
  static MachineFunction& construct(const Function *F, const TargetMachine 
&TM);

1. Because the comment use "//" and not "///" it does not show up in Doxygen 
docs.
2. What does "MachineFunction object for the given method" means? What's 
"method". Maybe, "Function" was intended to be used, so that comment would 
read:

  /// The next three methods are used to construct, destruct, and retrieve the
  /// MachineFunction object for the given Function object.method.

- Volodya




More information about the llvm-dev mailing list