From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: (qmail 10420 invoked by alias); 26 Feb 2014 00:02:02 -0000 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 Received: (qmail 10409 invoked by uid 89); 26 Feb 2014 00:02:01 -0000 Authentication-Results: sourceware.org; auth=none X-Virus-Found: No X-Spam-SWARE-Status: No, score=-1.2 required=5.0 tests=AWL,BAYES_20,RCVD_IN_DNSWL_NONE,RP_MATCHES_RCVD autolearn=ham version=3.3.2 X-HELO: elasmtp-curtail.atl.sa.earthlink.net Received: from elasmtp-curtail.atl.sa.earthlink.net (HELO elasmtp-curtail.atl.sa.earthlink.net) (209.86.89.64) by sourceware.org (qpsmtpd/0.93/v0.84-503-g423c35a) with ESMTP; Wed, 26 Feb 2014 00:02:00 +0000 Received: from [68.96.200.16] (helo=macbook2.local) by elasmtp-curtail.atl.sa.earthlink.net with esmtpa (Exim 4.67) (envelope-from ) id 1WIRwk-0006DZ-OB for gdb-patches@sourceware.org; Tue, 25 Feb 2014 19:01:58 -0500 Message-ID: <530D2EF0.50208@earthlink.net> Date: Wed, 26 Feb 2014 00:02:00 -0000 From: Stan Shebs User-Agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10.7; rv:24.0) Gecko/20100101 Thunderbird/24.3.0 MIME-Version: 1.0 To: gdb-patches@sourceware.org Subject: Re: [PATCH] Doxygenate defs.h References: <530285BC.90102@earthlink.net> In-Reply-To: <530285BC.90102@earthlink.net> Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 7bit X-ELNK-Trace: ae6f8838ff913eba0cc1426638a40ef67e972de0d01da94007ae3c780e0650b5b57d38cfd8e2f541350badd9bab72f9c350badd9bab72f9c350badd9bab72f9c X-IsSubscribed: yes X-SW-Source: 2014-02/txt/msg00769.txt.bz2 On 2/17/14 1:57 PM, Stan Shebs wrote: > This is a first patch that modifies source code to be more useful with > Doxygen. It does little more than add an extra "*" to comment blocks > that document the source construct immediately following. > > In keeping with our usual practice, I have not changed anything outside > comments, and the comments themselves are only minimally tweaked, > despite the great temptation to expand on some of the more cryptic. :-) > > I'll push this in a couple days if people are willing to live with this > format for comments. Next up, minsyms.h. > > Stan > stan@codesourcery.com > > 2014-02-17 Stan Shebs > > * defs.h: Annotate comments for Doxygen. > This is now pushed. While I recognize that this direction is not unanimously popular, I think this is something we need to try; as always, we can back it all out a year from now if we are not finding it helpful. Stan stan@codesourcery.com