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

Justin Bogner mail at justinbogner.com
Thu May 21 22:42:34 PDT 2015


Jonathan Roelofs <jroelofs.lists at gmail.com> writes:
> 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.

Yep, no need to use \brief anymore. Discussed here:

  http://lists.cs.uiuc.edu/pipermail/llvmdev/2015-May/085140.html

Happened here:

  http://lists.cs.uiuc.edu/pipermail/llvm-commits/Week-of-Mon-20150511/276766.html



More information about the cfe-commits mailing list