public inbox for u-boot@lists.denx.de
 help / color / mirror / Atom feed
From: Marek Vasut <marex@denx.de>
To: u-boot@lists.denx.de
Subject: [U-Boot] [PATCH] WIP: cbfs: Add docbook template
Date: Thu, 1 Nov 2012 00:39:48 +0100	[thread overview]
Message-ID: <201211010039.48553.marex@denx.de> (raw)
In-Reply-To: <1351722443-8281-1-git-send-email-sjg@chromium.org>

Dear Simon Glass,

> This adds a docbook template for fs, and makes CBFS use it.
> 
> Problems (advise please as I have enough 500pp books in my bookshelf):
> 
> 1. It requires the function names to be repeated. I would like to do this:

Repeating function names is good, you can be sure what the comment is associated 
with.

[...]

> 2. It will not accept the doxygen @param style for parameters:

It's not doxygen, sorry. Read [1].

btw. I'd like some kind of @return, but maybe describing the return value in 
comment is enough.

[...]

[1] http://www.denx.de/wiki/U-Boot/CodingStyle

Best regards,
Marek Vasut

  reply	other threads:[~2012-10-31 23:39 UTC|newest]

Thread overview: 4+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2012-10-31 22:27 [U-Boot] [PATCH] WIP: cbfs: Add docbook template Simon Glass
2012-10-31 23:39 ` Marek Vasut [this message]
2012-11-02  2:23   ` Simon Glass
2012-11-02  3:39     ` 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=201211010039.48553.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 a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox