On Tue, May 15, 2018 at 11:01:30AM +0300, Jani Nikula wrote: > On Mon, 14 May 2018, Luc Van Oostenryck <luc.vanoostenryck@xxxxxxxxx> wrote: > > Convert existing API doc in ptrlist.c to a kerneldoc-like > > format and document a few more interfaces. > > It's your code base, I don't have a vested interest, but since you Cc'd > me I can't help but urge you to consider choosing *one* documentation > comment style, and sticking with it. That is, either /** ... */ or /// > but not both. Yes, you're right. > In the same vein, I suggest sticking with minimalistic mainstream > documentation comment syntaxes. Steal the best parts of > javadoc/doxygen/kernel-doc, but don't emulate their mistakes. ;) Hehe :) The real question to me is "which parts are mistakes and which are not?" but I'm all in favor of simplicity. I think I'll begin to document the documentation syntax. Thanks for the advice, -- Luc -- To unsubscribe from this list: send the line "unsubscribe linux-sparse" in the body of a message to majordomo@xxxxxxxxxxxxxxx More majordomo info at http://vger.kernel.org/majordomo-info.html
