On Mon, Dec 19, 2011 at 10:08 AM, Tommi Virtanen
<[email protected]> wrote:
> On Fri, Dec 16, 2011 at 12:52, Josh Durgin <[email protected]> wrote:
>> I've been documenting the librados C api, and would like to get some
>> feedback on the format being used. For each function, the format is
>> generally:
>>
>> /**
>>  * Short description
>>  *
>
> Personally I've never been crazy about the "*" prefix on every line,
> it looks just like extra work without value to me. Doxygen itself is
> perfectly happy with just
>
> /**
>  Short description
>
>  blah
>  blah
>  */
>
> But whatever makes sense for you guys.
I like it as a visibility and "comment type" thing. Plus any good
editor will auto-type those for you... ;)
-Greg
--
To unsubscribe from this list: send the line "unsubscribe ceph-devel" in
the body of a message to [email protected]
More majordomo info at  http://vger.kernel.org/majordomo-info.html

Reply via email to