From mboxrd@z Thu Jan  1 00:00:00 1970
From: Jeroen Hofstee <dasuboot@myspectrum.nl>
Date: Sat, 16 Aug 2014 00:01:47 +0200
Subject: [U-Boot] [PATCH 2/3] image: move all function comments to
 header file
In-Reply-To: <1408136128-16240-2-git-send-email-pengw@nvidia.com>
References: <1408136128-16240-1-git-send-email-pengw@nvidia.com>
	<1408136128-16240-2-git-send-email-pengw@nvidia.com>
Message-ID: <53EE834B.3060608@myspectrum.nl>
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

Hello Bryan,

On 15-08-14 22:55, Bryan Wu wrote:
> Several functions comments are C file with function definition, they
> should be moved to header file with function declaration.
>
> Also update genimg_get_kernel_addr() comments for CONFIG_FIT case.
>
> Signed-off-by: Bryan Wu <pengw@nvidia.com>
>

Why _should_ this be done. In general I would not do it
to keep comment and implementation close to each other.
(In the hope they actually match). Doxygen and likely the
kernel doc thing can pick this up. The only reason I can
think of this being useful is for proprietary code with a public
api, but this is not applicable for u-boot.

Regards,
Jeroen