[U-Boot] KernelDoc

Marek Vasut
2012-09-26T19:54:59Z

Dear Wolfgang Denk,

> Dear Marek,
>
> In message <201209262110.18172.marex@denx.de> you wrote:
> > > But we need to borrow the Documentation/DocBook
> > > Makefile and logic and so on from the kernel first. And add template
> > > files for the DM sections so something can be spit out.
> >
> > I'd leave that for step 2 (documentation generation) and don't bother
> > with this right away.
>
> If you don't build documentation right from the beginning, you will
> not notice any errors or deficiencies in the comments, and reworking
> later will be way more effort.

I agree with this, but I can not do that right now. I'm flat out too swamped.

> I think if we add it, then it needs to be done Right (TM).

I agree

OT: I would hate to rework the patches that already follow that style and then
rework them again. Maybe we can do a compromise, drop the initial double-
asterisk and otherwise follow the kernel-doc?

> Best regards,
>
> Wolfgang Denk

Best regards,
Marek Vasut