From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: (qmail 16656 invoked by alias); 1 Nov 2013 11:18:47 -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 16640 invoked by uid 89); 1 Nov 2013 11:18:46 -0000 Authentication-Results: sourceware.org; auth=none X-Virus-Found: No X-Spam-SWARE-Status: No, score=-2.4 required=5.0 tests=AWL,BAYES_00,RP_MATCHES_RCVD,SPF_HELO_PASS,SPF_PASS autolearn=ham version=3.3.2 X-HELO: mx1.redhat.com Received: from mx1.redhat.com (HELO mx1.redhat.com) (209.132.183.28) by sourceware.org (qpsmtpd/0.93/v0.84-503-g423c35a) with ESMTP; Fri, 01 Nov 2013 11:18:45 +0000 Received: from int-mx02.intmail.prod.int.phx2.redhat.com (int-mx02.intmail.prod.int.phx2.redhat.com [10.5.11.12]) by mx1.redhat.com (8.14.4/8.14.4) with ESMTP id rA1BIg6J010505 (version=TLSv1/SSLv3 cipher=DHE-RSA-AES256-SHA bits=256 verify=OK); Fri, 1 Nov 2013 07:18:42 -0400 Received: from [127.0.0.1] (ovpn01.gateway.prod.ext.ams2.redhat.com [10.39.146.11]) by int-mx02.intmail.prod.int.phx2.redhat.com (8.13.8/8.13.8) with ESMTP id rA1BIeIE014208; Fri, 1 Nov 2013 07:18:41 -0400 Message-ID: <52738E10.7050007@redhat.com> Date: Fri, 01 Nov 2013 11:18:00 -0000 From: Pedro Alves User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:17.0) Gecko/20130625 Thunderbird/17.0.7 MIME-Version: 1.0 To: Stan Shebs CC: gdb-patches@sourceware.org Subject: Re: [RFC] Use Doxygen for internals documentation References: <525877F6.40001@earthlink.net> In-Reply-To: <525877F6.40001@earthlink.net> Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 7bit X-SW-Source: 2013-11/txt/msg00009.txt.bz2 On 10/11/2013 11:13 PM, Stan Shebs wrote: > > 1) Its parser get befuddled by some of our macrology. ... > 3) The only way I could find to get Emacs to preserve our current > formatting rules is to have the opening "/**" on a line by itself. GCC has these problems solved by running a simple filter on the sources before feeding them to doxygen. I think we could/should do the same. http://gcc.gnu.org/viewcvs/gcc/trunk/contrib/filter_params.pl?view=markup 1 #!/usr/bin/perl 2 3 # Filters out some of the #defines used throughout the GCC sources: 4 # - GTY(()) marks declarations for gengtype.c 5 # - PARAMS(()) is used for K&R compatibility. See ansidecl.h. 6 7 while (<>) { 8 s/^\/\* /\/\*\* \@verbatim /; 9 s/\*\// \@endverbatim \*\//; 10 s/GTY[ \t]*\(\(.*\)\)//g; 11 s/[ \t]ATTRIBUTE_UNUSED//g; 12 s/PARAMS[ \t]*\(\((.*?)\)\)/\($1\)/sg; 13 print; 14 } David Malcolm just recently posted a gcc patch that rewrites that in Python (and makes it smarter): http://gcc.gnu.org/ml/gcc-patches/2013-10/msg02728.html -- Pedro Alves