From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: (qmail 2901 invoked by alias); 15 Oct 2013 23:39:48 -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 2892 invoked by uid 89); 15 Oct 2013 23:39:48 -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,RCVD_IN_DNSWL_NONE,RP_MATCHES_RCVD autolearn=ham version=3.3.2 X-HELO: elasmtp-dupuy.atl.sa.earthlink.net Received: from elasmtp-dupuy.atl.sa.earthlink.net (HELO elasmtp-dupuy.atl.sa.earthlink.net) (209.86.89.62) by sourceware.org (qpsmtpd/0.93/v0.84-503-g423c35a) with ESMTP; Tue, 15 Oct 2013 23:39:47 +0000 Received: from [68.96.200.16] (helo=macbook2.local) by elasmtp-dupuy.atl.sa.earthlink.net with esmtpa (Exim 4.67) (envelope-from ) id 1VWEDI-0000ED-P1; Tue, 15 Oct 2013 19:39:44 -0400 Message-ID: <525DD240.6050205@earthlink.net> Date: Tue, 15 Oct 2013 23:39:00 -0000 From: Stan Shebs User-Agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10.7; rv:17.0) Gecko/20130801 Thunderbird/17.0.8 MIME-Version: 1.0 To: Yao Qi CC: gdb-patches@sourceware.org Subject: Re: [RFC] Use Doxygen for internals documentation References: <525877F6.40001@earthlink.net> <525BEF41.6010807@codesourcery.com> In-Reply-To: <525BEF41.6010807@codesourcery.com> Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 7bit X-ELNK-Trace: ae6f8838ff913eba0cc1426638a40ef67e972de0d01da940cabcdbcd17f5078dc067502ddfebacdf350badd9bab72f9c350badd9bab72f9c350badd9bab72f9c X-IsSubscribed: yes X-SW-Source: 2013-10/txt/msg00462.txt.bz2 On 10/14/13 6:18 AM, Yao Qi wrote: > On 10/12/2013 06:13 AM, Stan Shebs wrote: >> This patch is the third and final step in the transition away from the >> old GDB internals manual. So people can take a look without installing the patch, I put a copy of the output on github: http://stanshebs.github.io/gdb-doxy-test/ >> doxy/gdb-api - GDB's "API", basically what is in .h files >> doxy/gdb-xref - the full xref, voluminous > > Any reason to produce both of them? I'd like to have a single one. gdb-xref has the most information, but the cross-references can be lengthy - in utils.h for instance, the references to gdb_stderr etc fill multiple screens, and it's a distraction if you're just looking for the right function to print a ULONGEST. It wasn't obvious which one would be the most useful, and I didn't see an option to "twist out" the API into a full xref, so I just ran it twice. If one of these is disliked, no problem to eliminate - hackers can always create a personal page collection, doxygen is pretty fast if you skip the macro expansion. >> doxy/gdbserver - GDBserver xref >> doxy/xml - XML version, for further script-crunching > > Do you have an example that these xml files can be consumed by other tools? Not yet, still learning the XML-fu necessary. A couple easy examples would be "find orphans" and "report the percentage of the API that has been documented". Stan stan@codesourcery.com