From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: (qmail 22397 invoked by alias); 11 Feb 2014 19:19:51 -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 22386 invoked by uid 89); 11 Feb 2014 19:19:50 -0000 Authentication-Results: sourceware.org; auth=none X-Virus-Found: No X-Spam-SWARE-Status: No, score=-2.6 required=5.0 tests=AWL,BAYES_00,RP_MATCHES_RCVD autolearn=ham version=3.3.2 X-HELO: glazunov.sibelius.xs4all.nl Received: from sibelius.xs4all.nl (HELO glazunov.sibelius.xs4all.nl) (83.163.83.176) by sourceware.org (qpsmtpd/0.93/v0.84-503-g423c35a) with (AES256-GCM-SHA384 encrypted) ESMTPS; Tue, 11 Feb 2014 19:19:49 +0000 Received: from glazunov.sibelius.xs4all.nl (kettenis@localhost [127.0.0.1]) by glazunov.sibelius.xs4all.nl (8.14.5/8.14.3) with ESMTP id s1BJJgaT019179; Tue, 11 Feb 2014 20:19:42 +0100 (CET) Received: (from kettenis@localhost) by glazunov.sibelius.xs4all.nl (8.14.5/8.14.3/Submit) id s1BJJfLP012816; Tue, 11 Feb 2014 20:19:42 +0100 (CET) Date: Tue, 11 Feb 2014 19:19:00 -0000 Message-Id: <201402111919.s1BJJfLP012816@glazunov.sibelius.xs4all.nl> From: Mark Kettenis To: stanshebs@earthlink.net CC: gdb-patches@sourceware.org In-reply-to: <52FA7509.4010400@earthlink.net> (message from Stan Shebs on Tue, 11 Feb 2014 11:07:53 -0800) Subject: Re: [PATCH] Use Doxygen for internals documentation References: <52F420E0.9050203@earthlink.net> <52FA7509.4010400@earthlink.net> X-SW-Source: 2014-02/txt/msg00360.txt.bz2 > Date: Tue, 11 Feb 2014 11:07:53 -0800 > From: Stan Shebs > > On 2/6/14 3:55 PM, Stan Shebs wrote: > > Here is the official patch for the introduction of Doxygen that I > > proposed last fall. > > This is now pushed. > > I've added http://sourceware.org/gdb/wiki/DoxygenForGDB as the > initial info on what to do with it. > > I've also got defs.h, minsyms.h, and utils.[hc] in various states > of doxygenation, but won't spend a whole lot more time on them > before pushing them. > > For other popular header files, I suggest that if people > want to jump on any, that we use the wiki page as a simple > reservation system - although basic doxygenation of a file > need take only a few minutes, one invariably sees many ways > to fix up the comment blocks. When did we agree that using doxygen was a good idea? I don't want to spend my time on uglifying the source code with stuff that will never result in usable documentation. I don't want to be distracted by markup when I'm reading source code or comments. Most of all, I don't want to spend any time on arguing about these stupid things.