All of lore.kernel.org
 help / color / mirror / Atom feed
From: Marek Vasut <marex@denx.de>
To: u-boot@lists.denx.de
Subject: [U-Boot] KernelDoc
Date: Tue, 25 Sep 2012 22:46:10 +0200	[thread overview]
Message-ID: <201209252246.10322.marex@denx.de> (raw)

Hi all!

I've had a discussion with Wolfgang just now about U-Boot coding style. I tried 
using KernelDoc in a patch, which is not part of the U-Boot Coding Style now, 
thus it was rejected.

I really like the idea of annotating functions with proper description, thus I 
would like to ask, can we reach a general agreement and start using kerneldoc in 
U-Boot to annotate functions and possibly generate documentation? Or shall we 
use anything else?

Or any other annotation stuff? Doxygen style? Shall it be optional or mandatory?

See [1] in Linux kernel tree for what I mean.

[1] Documentation/kernel-doc-nano-HOWTO.txt

Best regards,
Marek Vasut

             reply	other threads:[~2012-09-25 20:46 UTC|newest]

Thread overview: 38+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2012-09-25 20:46 Marek Vasut [this message]
2012-09-26  6:50 ` [U-Boot] KernelDoc Prabhakar Lad
2012-09-26  7:12   ` Wolfgang Denk
2012-09-26  7:23     ` Prabhakar Lad
2012-09-26 10:07       ` Wolfgang Denk
2012-09-26  7:17 ` Wolfgang Denk
2012-09-26 15:26   ` Marek Vasut
2012-09-26 18:50     ` Joe Hershberger
2012-09-26 19:05       ` Marek Vasut
2012-09-26 19:54     ` Wolfgang Denk
2012-09-26 19:58       ` Marek Vasut
2012-09-26 20:57         ` Wolfgang Denk
2012-09-26 21:31           ` Tom Rini
2012-09-26 23:38           ` Marek Vasut
2012-10-01  8:54             ` Wolfgang Denk
2012-10-01  9:07               ` Marek Vasut
2012-10-01 10:35                 ` Wolfgang Denk
2012-10-01 10:37                   ` Marek Vasut
2012-10-09 22:49                     ` Tom Rini
2012-10-09 23:35                       ` Marek Vasut
2012-10-14 20:26                       ` Marek Vasut
2012-09-26 20:00       ` Tom Rini
2012-09-27  6:19       ` Stefan Roese
2012-09-27 17:26         ` Tom Rini
2012-09-27 17:28         ` Fabio Estevam
2012-09-27 23:50         ` Graeme Russ
2012-09-28  0:28           ` Marek Vasut
2012-09-28  0:28     ` Scott Wood
2012-09-28  0:44       ` Marek Vasut
2012-09-26 19:05 ` Tom Rini
2012-09-26 19:10   ` Marek Vasut
2012-09-26 19:46     ` Wolfgang Denk
2012-09-26 19:54       ` Marek Vasut
2012-09-26 20:49         ` Wolfgang Denk
2012-09-26 23:36           ` Marek Vasut
2012-09-26 19:57     ` Tom Rini
2012-09-26 23:39       ` Marek Vasut
2012-09-28 19:48 ` Marek Vasut

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=201209252246.10322.marex@denx.de \
    --to=marex@denx.de \
    --cc=u-boot@lists.denx.de \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body. 
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.