From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: (qmail 24988 invoked by alias); 7 Feb 2014 13:29:06 -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 24979 invoked by uid 89); 7 Feb 2014 13:29:05 -0000 Authentication-Results: sourceware.org; auth=none X-Virus-Found: No X-Spam-SWARE-Status: No, score=1.6 required=5.0 tests=AWL,BAYES_00,GARBLED_BODY autolearn=no version=3.3.2 X-HELO: relay1.mentorg.com Received: from relay1.mentorg.com (HELO relay1.mentorg.com) (192.94.38.131) by sourceware.org (qpsmtpd/0.93/v0.84-503-g423c35a) with ESMTP; Fri, 07 Feb 2014 13:29:04 +0000 Received: from svr-orw-fem-01.mgc.mentorg.com ([147.34.98.93]) by relay1.mentorg.com with esmtp id 1WBlUK-0007U0-D5 from Yao_Qi@mentor.com ; Fri, 07 Feb 2014 05:29:00 -0800 Received: from SVR-ORW-FEM-05.mgc.mentorg.com ([147.34.97.43]) by svr-orw-fem-01.mgc.mentorg.com over TLS secured channel with Microsoft SMTPSVC(6.0.3790.4675); Fri, 7 Feb 2014 05:29:00 -0800 Received: from qiyao.dyndns.org (147.34.91.1) by svr-orw-fem-05.mgc.mentorg.com (147.34.97.43) with Microsoft SMTP Server id 14.2.247.3; Fri, 7 Feb 2014 05:28:22 -0800 Message-ID: <52F4DF1B.9070100@codesourcery.com> Date: Fri, 07 Feb 2014 13:29:00 -0000 From: Yao Qi User-Agent: Mozilla/5.0 (X11; Linux i686; rv:17.0) Gecko/20130110 Thunderbird/17.0.2 MIME-Version: 1.0 To: Stan Shebs CC: gdb-patches Subject: Re: [PATCH] Use Doxygen for internals documentation References: <52F420E0.9050203@earthlink.net> In-Reply-To: <52F420E0.9050203@earthlink.net> Content-Type: text/plain; charset="UTF-8" Content-Transfer-Encoding: 8bit X-IsSubscribed: yes X-SW-Source: 2014-02/txt/msg00196.txt.bz2 Stan, I applied this patch and run 'make doxy' in dir doc. It looks good! On 02/07/2014 07:55 AM, Stan Shebs wrote: > +

> +These are primarily useful for people working on GDB itself. Users of > +GDB, people working with stubs, and people working on frontends to GDB > +are all better served by the GDB manual, which is the official > +definition for all of GDB's external interfaces. We may add a link to GDB manual. > diff --git a/gdb/doc/filter-for-doxygen b/gdb/doc/filter-for-doxygen > new file mode 100755 > index 0000000..457d088 > --- /dev/null > +++ b/gdb/doc/filter-for-doxygen > @@ -0,0 +1,14 @@ > +#!/bin/sh > + Missing copyright header? > +# This filters GDB source before Doxygen can get confused by it; > +# this script is listed in the doxyfile. The output is not very > +# pretty, but at least we get output that Doxygen can understand. > +# > +# $1 is a source file of some kind. The source we wish doxygen to > +# process is put on stdout. > + > +# (Adapted from gcc/contrib/filter_gcc_for_doxygen) > + > +dir=`dirname $0` > +perl $dir/filter-params.pl < $1 > +exit 0 > diff --git a/gdb/doc/filter-params.pl b/gdb/doc/filter-params.pl > new file mode 100644 > index 0000000..eedcc5b > --- /dev/null > +++ b/gdb/doc/filter-params.pl > @@ -0,0 +1,11 @@ > +#!/usr/bin/perl > + Likewise. > +# This Perl script tweaks GDB sources to be more useful for Doxygen. > + > +while (<>) { > + # Allow "/* * " as an equivalent to "/** ", better for Emacs compat. > + s/^\/\* \* /\/** /sg; > + # Manually expand macro seen in structs and such. > + s/ENUM_BITFIELD[ \t]*\((.*?)\)/__extension__ enum $1/sg; Why do we need this substitution here? Anything wrong if we don't do the substitution? I don't recall this was asked in last review. -- Yao (齐尧)