[PATCH] Adding doxygen comments to the LLVM intrinsics (part 1, ammintrin.h)

[Jonathan Roelofs]

On 5/21/15 8:54 PM, Katya Romanova wrote:
> Sorry for the delay. A technical writer had to be involved. Unfortunately, all the content-related changes (vs. changes in the doxygen tool generator itself that I totally control) will take a long time.
>
> Addressed Dmitri's comments. The only thing that I left "as is" is a length of a bitfield. I looked up MS documentation for these intrinsics. The word 'length' used all the time.
>
>>> Also, the word 'length' does not have the right connotation, I think. 'Bits [5:0] specify the number of bits to extract, other bits are ignored' -- I think something like this would be much better.
>
>>

One format comment before these go in:

+/// \brief Extracts the specified bits from the lower 64 bits of the 
128-bit
+///    integer vector operand at the index idx and of the length len.

I've heard murmurs that `\brief` style comments are going away because 
someone found a flag that enables autobrief for the first line.  So for 
these it's probably better to have it be formatted like:

+/// Extracts the specified bits from the lower 64 bits of the 128-bit
+/// integer vector operand at the index idx and of the length len.

Sorry I don't have a pointer to the thread about that style change.


Cheers,

Jon

>
>
>
> http://reviews.llvm.org/D8762
>
> Files:
>    lib/Headers/ammintrin.h
>
> EMAIL PREFERENCES
>    http://reviews.llvm.org/settings/panel/emailpreferences/
>
>
>
> _______________________________________________
> cfe-commits mailing list
> cfe-commits at cs.uiuc.edu
> http://lists.cs.uiuc.edu/mailman/listinfo/cfe-commits
>

-- 
Jon Roelofs
jonathan at codesourcery.com
CodeSourcery / Mentor Embedded