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

[Dmitri Gribenko]

On Fri, Jan 4, 2013 at 2:58 AM, John McCall <rjmccall at apple.com> wrote:
> 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.

The issue is that there are no parameters named 'array',
'destructionKind' and 'initializedElementCount' in the function, thus
-Wdocumentation was complaining.

> 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*.

I am sorry that valuable documentation was pruned.  We would
appreciate if you could update this comment when llvm.org goes up.

Dmitri

-- 
main(i,j){for(i=2;;i++){for(j=2;j<i;j++){if(!(i%j)){j=0;break;}}if
(j){printf("%d\n",i);}}} /*Dmitri Gribenko <gribozavr at gmail.com>*/