From mboxrd@z Thu Jan  1 00:00:00 1970
From: Marek Vasut <marex@denx.de>
Date: Thu, 1 Nov 2012 00:39:48 +0100
Subject: [U-Boot] [PATCH] WIP: cbfs: Add docbook template
In-Reply-To: <1351722443-8281-1-git-send-email-sjg@chromium.org>
References: <1351722443-8281-1-git-send-email-sjg@chromium.org>
Message-ID: <201211010039.48553.marex@denx.de>
List-Id: <u-boot.lists.denx.de>
MIME-Version: 1.0
Content-Type: text/plain; charset="us-ascii"
Content-Transfer-Encoding: 7bit
To: u-boot@lists.denx.de

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