From mboxrd@z Thu Jan  1 00:00:00 1970
Received: from mailman by lists.gnu.org with archive (Exim 4.33)
	id 1BeEiO-0001do-Dx
	for mharc-grub-devel@gnu.org; Sat, 26 Jun 2004 11:03:36 -0400
Received: from mailman by lists.gnu.org with tmda-scanned (Exim 4.33)
	id 1BeEiM-0001di-Gr
	for grub-devel@gnu.org; Sat, 26 Jun 2004 11:03:34 -0400
Received: from exim by lists.gnu.org with spam-scanned (Exim 4.33)
	id 1BeEiK-0001dW-VE
	for grub-devel@gnu.org; Sat, 26 Jun 2004 11:03:34 -0400
Received: from [199.232.76.173] (helo=monty-python.gnu.org)
	by lists.gnu.org with esmtp (Exim 4.33) id 1BeEiK-0001dT-Rn
	for grub-devel@gnu.org; Sat, 26 Jun 2004 11:03:32 -0400
Received: from [212.43.237.68] (helo=kotoba.storever.com)
	by monty-python.gnu.org with esmtp (Exim 4.34) id 1BeEgR-0005g8-P7
	for grub-devel@gnu.org; Sat, 26 Jun 2004 11:01:36 -0400
Received: from localhost.localdomain (localhost.localdomain [127.0.0.1])
	by kotoba.storever.com (Postfix) with ESMTP id 3BB12F0D47A1
	for <grub-devel@gnu.org>; Sat, 26 Jun 2004 11:01:35 -0400 (EDT)
From: "Yoshinori K. Okuji" <okuji@enbug.org>
Organization: enbug.org
To: The development of GRUB 2 <grub-devel@gnu.org>
Date: Sat, 26 Jun 2004 17:05:44 +0200
User-Agent: KMail/1.6.1
References: <20040624171029.GA19940@artax.karlin.mff.cuni.cz>
	<200406250003.53439.okuji@enbug.org>
	<87brj7u691.wl@pc-jeroen.dekkers.cx>
In-Reply-To: <87brj7u691.wl@pc-jeroen.dekkers.cx>
MIME-Version: 1.0
Content-Disposition: inline
Content-Type: text/plain;
  charset="iso-8859-1"
Content-Transfer-Encoding: 7bit
Message-Id: <200406261705.44157.okuji@enbug.org>
Subject: Re: Documentation.
X-BeenThere: grub-devel@gnu.org
X-Mailman-Version: 2.1.4
Precedence: list
Reply-To: The development of GRUB 2 <grub-devel@gnu.org>
List-Id: The development of GRUB 2 <grub-devel.gnu.org>
List-Unsubscribe: <http://lists.gnu.org/mailman/listinfo/grub-devel>,
	<mailto:grub-devel-request@gnu.org?subject=unsubscribe>
List-Archive: <http://lists.gnu.org/pipermail/grub-devel>
List-Post: <mailto:grub-devel@gnu.org>
List-Help: <mailto:grub-devel-request@gnu.org?subject=help>
List-Subscribe: <http://lists.gnu.org/mailman/listinfo/grub-devel>,
	<mailto:grub-devel-request@gnu.org?subject=subscribe>
X-List-Received-Date: Sat, 26 Jun 2004 15:03:34 -0000

On Friday 25 June 2004 15:17, Jeroen Dekkers wrote:
> The best way to document the internals is in the code, so that when
> the code changes the comments change with it. To describe the
> interfaces you can write verbose header files for example.

You are right, if you talk about the API. But I don't think Tomas meant 
the API but the design or something similar. For example, "how to add a 
new command" is a bit difficult to document in header files, because 
the information would be scattered.

Okuji