On Thu, Apr 21, 2022 at 08:34:10PM +0200, Victor Toso wrote:
Not sure I understood what is preferable. For all functions and typdefs and macros, it should be:
Line 1 /** 2 * type_name: 3 * 4 * Maybe some comment. 5 * 6 * Maybe something about return value. 7 * 8 * Since: v1.2.3 9 * 10 */
Do you suggest to not have empty line 9 ?
Correct.
For enum values, if they are multiple line comments, I try to follow the above too. Otherwise, to avoid adding lots of extra empty lines around where we only had a single line as comment before, I've only appended the Since tag.
Yeah, that sounds sensible. I think it would be nice to use the same multi-line, documentation-right-above-symbol style everywhere, but it would most likely become too unwieldy in practice, especially for large enums. -- Andrea Bolognani / Red Hat / Virtualization