From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: (qmail 25070 invoked by alias); 13 Jun 2009 11:12:26 -0000 Received: (qmail 25062 invoked by uid 22791); 13 Jun 2009 11:12:26 -0000 X-SWARE-Spam-Status: No, hits=-2.4 required=5.0 tests=AWL,BAYES_00 X-Spam-Check-By: sourceware.org Received: from rock.gnat.com (HELO rock.gnat.com) (205.232.38.15) by sourceware.org (qpsmtpd/0.43rc1) with ESMTP; Sat, 13 Jun 2009 11:12:16 +0000 Received: from localhost (localhost.localdomain [127.0.0.1]) by filtered-rock.gnat.com (Postfix) with ESMTP id C96332BAAED; Sat, 13 Jun 2009 07:12:14 -0400 (EDT) Received: from rock.gnat.com ([127.0.0.1]) by localhost (rock.gnat.com [127.0.0.1]) (amavisd-new, port 10024) with LMTP id 3X0A+Np9ntjc; Sat, 13 Jun 2009 07:12:14 -0400 (EDT) Received: from joel.gnat.com (localhost.localdomain [127.0.0.1]) by rock.gnat.com (Postfix) with ESMTP id 9AC202BAAEB; Sat, 13 Jun 2009 07:12:14 -0400 (EDT) Received: by joel.gnat.com (Postfix, from userid 1000) id 1E877F596C; Sat, 13 Jun 2009 07:12:10 -0400 (EDT) Date: Sat, 13 Jun 2009 11:12:00 -0000 From: Joel Brobecker To: Eli Zaretskii Cc: Pedro Alves , gdb-patches@sourceware.org Subject: Re: [commit] cleanup stale exec.{h|c} xfer_memory comments. Message-ID: <20090613111210.GN25703@adacore.com> References: <200906121943.08246.pedro@codesourcery.com> MIME-Version: 1.0 Content-Type: text/plain; charset=us-ascii Content-Disposition: inline In-Reply-To: User-Agent: Mutt/1.5.18 (2008-05-17) Mailing-List: contact gdb-patches-help@sourceware.org; run by ezmlm Precedence: bulk List-Id: List-Subscribe: List-Archive: List-Post: List-Help: , Sender: gdb-patches-owner@sourceware.org X-SW-Source: 2009-06/txt/msg00352.txt.bz2 > Is the convention to describe functions in headers? That's reasonable > for data structures, but we have a lot of functions documented right > before their source, not in the headers. I find the documentation in > the .c files easier to use, because you don't need to consult another > file. This is C, not C++, so the interface and the implementation are > not separated. Unfortunately, I don't think we really have a hard convention in GDB. For C, I also tend to prefer documenting the function next to the implementation. It's the only way to be consistent, since some functions do not have advance declarations. -- Joel