[cfe-commits] r171013 - /cfe/trunk/lib/CodeGen/CGDecl.cpp

[John McCall]

On Dec 23, 2012, at 5:48 PM, NAKAMURA Takumi <geek4civic at gmail.com> wrote:
> Author: chapuni
> Date: Sun Dec 23 19:48:59 2012
> New Revision: 171013
> 
> URL: http://llvm.org/viewvc/llvm-project?rev=171013&view=rev
> Log:
> CGDecl.cpp: Prune three descriptions in two methods, CodeGenFunction::pushIrregularPartialArrayCleanup() and CodeGenFunction::pushRegularPartialArrayCleanup(). [-Wdocumentation]
> 
> /// \param array - a value of type elementType*
> /// \param destructionKind - the kind of destruction required
> /// \param initializedElementCount - a value of type size_t* holding the number of successfully-constructed elements

Wait, why are you pruning these?  Other than destructionKind, this is all valuable documentation.

When documentation in IR-generation talks about the type of a parameter, it's generally not repeating information from the C++ type system;  it's talking about the type *of an abstract value*.  That is, initializedElementCount is (in C++) just an llvm::Value*, but the documentation is clarifying that that llvm::Value* must have LLVM IR type size_t*, i.e. i32* or i64*.

John.