[llvm-commits] [llvm] r118248 - in /llvm/trunk: include/llvm/Analysis/DIBuilder.h lib/Analysis/CMakeLists.txt lib/Analysis/DIBuilder.cpp

[Frits van Bommel]

> +    /// CreateCompileUnit - A CompileUnit provides an anchor for all debugging
> +    /// information generated during this instance of compilation.
> +    void CreateCompileUnit(unsigned Lang, StringRef F, StringRef D, StringRef P,
> +                           bool isOptimized, StringRef Flags, unsigned RV);

Since it's "intended to be a front-end friendly interface", maybe you
should document these parameters? Or at least give them more
meaningful names?

> +    /// CreateBasicType - Create debugging information entry for a basic
> +    /// type, e.g 'char'.
> +    DIType CreateBasicType(StringRef Name, uint64_t SizeInBits,
> +                           uint64_t AlignInBits, unsigned Encoding);

Ditto. Especially "Encoding" -- what's that for? How is the encoding encoded? :)
(Maybe it should have an enum type instead?)

> +    /// CreateQaulifiedType - Create debugging information entry for a qualified
> +    /// type, e.g. 'const int'.
> +    DIType CreateQualifiedType(unsigned Tag, DIType FromTy);

Tag is also unclear, what value is one supposed to pass here?
Also, you typo'd the function name in the comment.

> +    /// CreateInheritance - Create debugging information entry to establish
> +    /// inheritnace relationship between two types.
> +    DIType CreateInheritance(DIType Ty, DIType BaseTy, uint64_t BaseOffset,
> +                             unsigned Flags);

typo'd inheritance.