r210039 - Fix comment vs function name mismatch

Hans Wennborg hans at chromium.org
Mon Jun 2 14:50:45 PDT 2014


On Mon, Jun 2, 2014 at 2:15 PM, Richard Smith <richard at metafoo.co.uk> wrote:
> On Mon, Jun 2, 2014 at 11:50 AM, Hans Wennborg <hans at hanshq.net> wrote:
>>
>> Author: hans
>> Date: Mon Jun  2 13:50:54 2014
>> New Revision: 210039
>>
>> URL: http://llvm.org/viewvc/llvm-project?rev=210039&view=rev
>> Log:
>> Fix comment vs function name mismatch
>>
>> Modified:
>>     cfe/trunk/lib/CodeGen/CGVTables.h
>>
>> Modified: cfe/trunk/lib/CodeGen/CGVTables.h
>> URL:
>> http://llvm.org/viewvc/llvm-project/cfe/trunk/lib/CodeGen/CGVTables.h?rev=210039&r1=210038&r2=210039&view=diff
>>
>> ==============================================================================
>> --- cfe/trunk/lib/CodeGen/CGVTables.h (original)
>> +++ cfe/trunk/lib/CodeGen/CGVTables.h Mon Jun  2 13:50:54 2014
>> @@ -99,7 +99,7 @@ public:
>>                               VTableAddressPointsMapTy& AddressPoints);
>>
>>
>> -  /// GetAddrOfVTable - Get the address of the VTT for the given record
>> decl.
>> +  /// GetAddrOfVTT - Get the address of the VTT for the given record
>> decl.
>
>
> For future reference, the preferred fix would be to remove the function name
> entirely. (We usually also add \brief here, but that's redundant here since
> a single-line doc comment is implicitly \brief.)

Right. I just didn't want to create inconsistency with the rest of the
class, and avoid the churn of changing the other methods to use \brief
:-/



More information about the cfe-commits mailing list