* [U-Boot] kernel-doc vs Doxygen
@ 2019-08-14 18:16 Sam Protsenko
2019-08-15 13:51 ` Tom Rini
0 siblings, 1 reply; 3+ messages in thread
From: Sam Protsenko @ 2019-08-14 18:16 UTC (permalink / raw)
To: u-boot
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.
Thanks!
^ permalink raw reply [flat|nested] 3+ messages in thread
* [U-Boot] kernel-doc vs Doxygen
2019-08-14 18:16 [U-Boot] kernel-doc vs Doxygen Sam Protsenko
@ 2019-08-15 13:51 ` Tom Rini
2019-08-15 17:26 ` Sam Protsenko
0 siblings, 1 reply; 3+ messages in thread
From: Tom Rini @ 2019-08-15 13:51 UTC (permalink / raw)
To: u-boot
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!
--
Tom
-------------- next part --------------
A non-text attachment was scrubbed...
Name: signature.asc
Type: application/pgp-signature
Size: 819 bytes
Desc: not available
URL: <http://lists.denx.de/pipermail/u-boot/attachments/20190815/473bfa00/attachment.sig>
^ permalink raw reply [flat|nested] 3+ messages in thread
* [U-Boot] kernel-doc vs Doxygen
2019-08-15 13:51 ` Tom Rini
@ 2019-08-15 17:26 ` Sam Protsenko
0 siblings, 0 replies; 3+ messages in thread
From: Sam Protsenko @ 2019-08-15 17:26 UTC (permalink / raw)
To: u-boot
On Thu, Aug 15, 2019 at 4:51 PM Tom Rini <trini@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
^ permalink raw reply [flat|nested] 3+ messages in thread
end of thread, other threads:[~2019-08-15 17:26 UTC | newest]
Thread overview: 3+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2019-08-14 18:16 [U-Boot] kernel-doc vs Doxygen Sam Protsenko
2019-08-15 13:51 ` Tom Rini
2019-08-15 17:26 ` Sam Protsenko
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.