[cfe-dev] clang-format, Doxygen comments

Alexander Kornienko alexfh at google.com
Mon Oct 13 03:32:22 PDT 2014


On Fri, Oct 10, 2014 at 8:39 AM, Daniel Jasper <djasper at google.com> wrote:

> There are two fundamental things to do here:
> - Properly format doxygen comments (ideally understanding things like the
> "<".
> - Re-flowing of comments (doxygen or not)
>
> Both have been on our list for quite some time, but we never really got
> around to it.
>
> Alex, how hard would it be to add basic re-flowing?
>

Token breaking and alignment code is pretty fragile, so it's hard to say
how long will it take. My rough guess is that it should be doable in a week
or so. I can look at it some time this week to get a better idea.


> On Thu, Oct 9, 2014 at 8:22 PM, Karl Napf <karl.b.napf at googlemail.com>
> wrote:
>
>> Hi, I would like to reformat an existing code base using clang-format
>> (according to the Google guidelines). As shown below, the line breaking of
>> some Doxygen comments is not yet optimal using version 3.5. Any hints on
>> how to avoid this? Is there special support for Doxygen comments in
>> clang-format? Thank you very much in advance for your help! Regards
>>
>>
>> Before:
>>
>> void fun(
>>   RAI last,
>>   /**< [IN] Random access iterator [...] of the
>>             input range */
>>
>> After:
>>
>> void fun(
>>     RAI last,
>>     /**< [IN] Random access iterator [...] of
>>        the
>>               input range */
>>
>> Ideally:
>>
>> void fun(
>>     RAI last,
>>     /**< [IN] Random access iterator [...] of
>>        the input range */
>>
>
> Why not:
>
>  void fun(
>     RAI last,
>     /**< [IN] Random access iterator [...] of
>               the input range */
>
> ?
>
>
>>
>> _______________________________________________
>> cfe-dev mailing list
>> cfe-dev at cs.uiuc.edu
>> http://lists.cs.uiuc.edu/mailman/listinfo/cfe-dev
>>
>>
>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.llvm.org/pipermail/cfe-dev/attachments/20141013/bc1e3b38/attachment.html>


More information about the cfe-dev mailing list