From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: (qmail 23630 invoked by alias); 16 Jun 2009 00:20:06 -0000 Received: (qmail 23622 invoked by uid 22791); 16 Jun 2009 00:20:05 -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; Tue, 16 Jun 2009 00:19:57 +0000 Received: from localhost (localhost.localdomain [127.0.0.1]) by filtered-rock.gnat.com (Postfix) with ESMTP id B42C42BAAF7; Mon, 15 Jun 2009 20:19:55 -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 IQHUzd3YKa5n; Mon, 15 Jun 2009 20:19:55 -0400 (EDT) Received: from joel.gnat.com (localhost.localdomain [127.0.0.1]) by rock.gnat.com (Postfix) with ESMTP id 6B7732BAAF1; Mon, 15 Jun 2009 20:19:55 -0400 (EDT) Received: by joel.gnat.com (Postfix, from userid 1000) id 3E8CFF596C; Mon, 15 Jun 2009 17:19:53 -0700 (PDT) Date: Tue, 16 Jun 2009 00:20:00 -0000 From: Joel Brobecker To: Tom Tromey Cc: Eli Zaretskii , Pedro Alves , gdb-patches@sourceware.org Subject: Re: [commit] cleanup stale exec.{h|c} xfer_memory comments. Message-ID: <20090616001953.GA7730@adacore.com> References: <200906121943.08246.pedro@codesourcery.com> <20090613111210.GN25703@adacore.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/msg00400.txt.bz2 > FWIW, I prefer to have documentation in the header for a module's > public API, and next to the implementation for the private API. > Consistency doesn't matter as much to me as being able to read a > header file and get a grasp of how I would use a module; the private > comments in the module can then describe the implementation. I would be OK with this approach too. -- Joel