[U-Boot] kernel-doc vs Doxygen

Sam Protsenko semen.protsenko at linaro.org
Thu Aug 15 17:26:00 UTC 2019


On Thu, Aug 15, 2019 at 4:51 PM Tom Rini <trini at konsulko.com> wrote:
>
> On Wed, Aug 14, 2019 at 09:16:40PM +0300, Sam Protsenko wrote:
>
> > Hi everyone,
> >
> > Quick question: which comment style is allowed in U-Boot, kernel-doc
> > or Doxygen one? I have noticed that both are used currently (and I've
> > sent some patches with doxy comments myself). Please tell me if
> > somebody is actually running either kernel-doc or Doxygen to generate
> > the U-Boot documentation. If one particular style is preferred, maybe
> > it's worth to mention it somewhere in doc/ or in README.
>
> We're (slowly) moving towards once again following the kernel now that
> there's real consistent effort on that front that we can make use of,
> thanks!
>

Thanks, Tom. I'll stick to kernel-doc format in my patches then.

> --
> Tom


More information about the U-Boot mailing list