On Sat, Mar 20, 2021 at 01:26:21PM +0100, Christian Brauner wrote: > +/** > + * kuid_into_mnt - map a kuid down into a mnt_userns > + * @mnt_userns: user namespace of the relevant mount > + * @kuid: kuid to be mapped > + * > + * Return @kuid mapped according to @mnt_userns. > + * If @kuid has no mapping INVALID_UID is returned. > + */ If you could just put the ':' after 'Return', htmldoc would put this into a nice section for you. I also like to include a Context: section which lists whether the function takes locks / requires locks to be held / can be called in hard or soft interrupt context / may sleep / requires refcounts be held / ... Generally, what do you expect from your callers, and what your callers can expect from you. I don't understand the thing you're documenting, so it may not make sense to talk about interrupt context, for example.
