MachineFunction::create docs

Project Infrastructure LLVM Dev List Archives
1

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

2

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

[snip]

1. Because the comment use "//" and not "///" it does not show up in Doxygen
docs.

Fixed.

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:

Yes, it should be "Function".

Results:

http://mail.cs.uiuc.edu/pipermail/llvm-commits/Week-of-Mon-20040531/015003.html

Thanks for bringing it to our attention!