[llvm-commits] [llvm] r170607 - /llvm/trunk/include/llvm/MC/MCInstrDesc.h

[Jim Grosbach]

Aha! Right. I remembered the "don't include the name" bit, but forgot the "add \brief" part. Thanks!

-Jim

On Dec 19, 2012, at 4:36 PM, Matt Beaumont-Gay <matthewbg at google.com> wrote:

> On Wed, Dec 19, 2012 at 3:38 PM, Jim Grosbach <grosbach at apple.com> wrote:
>> Author: grosbach
>> Date: Wed Dec 19 17:38:44 2012
>> New Revision: 170607
>> 
>> URL: http://llvm.org/viewvc/llvm-project?rev=170607&view=rev
>> Log:
>> Fix doc comment. '///' not '//'.
>> 
>> Modified:
>>    llvm/trunk/include/llvm/MC/MCInstrDesc.h
>> 
>> Modified: llvm/trunk/include/llvm/MC/MCInstrDesc.h
>> URL: http://llvm.org/viewvc/llvm-project/llvm/trunk/include/llvm/MC/MCInstrDesc.h?rev=170607&r1=170606&r2=170607&view=diff
>> ==============================================================================
>> --- llvm/trunk/include/llvm/MC/MCInstrDesc.h (original)
>> +++ llvm/trunk/include/llvm/MC/MCInstrDesc.h Wed Dec 19 17:38:44 2012
>> @@ -258,9 +258,9 @@
>>     return isBranch() & isBarrier() & !isIndirectBranch();
>>   }
>> 
>> -  // isPredicable - Return true if this instruction has a predicate operand that
>> -  // controls execution.  It may be set to 'always', or may be set to other
>> -  /// values.   There are various methods in TargetInstrInfo that can be used to
>> +  /// isPredicable - Return true if this instruction has a predicate operand
> 
> As long as you're cleaning this up, the new approved style is to use
> \brief and not to include the function name (Doxygen is smart enough
> to figure out the name on its own).
> 
> http://llvm.org/docs/CodingStandards.html#doxygen-use-in-documentation-comments
> 
>> +  /// that controls execution. It may be set to 'always', or may be set to other
>> +  /// values. There are various methods in TargetInstrInfo that can be used to
>>   /// control and modify the predicate in this instruction.
>>   bool isPredicable() const {
>>     return Flags & (1 << MCID::Predicable);
>> 
>> 
>> _______________________________________________
>> llvm-commits mailing list
>> llvm-commits at cs.uiuc.edu
>> http://lists.cs.uiuc.edu/mailman/listinfo/llvm-commits