From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: (qmail 2021 invoked by alias); 8 Feb 2014 05:27:18 -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 2012 invoked by uid 89); 8 Feb 2014 05:27:18 -0000 Authentication-Results: sourceware.org; auth=none X-Virus-Found: No X-Spam-SWARE-Status: No, score=-3.2 required=5.0 tests=AWL,BAYES_00,RCVD_IN_DNSWL_LOW,RP_MATCHES_RCVD,SPF_PASS autolearn=ham version=3.3.2 X-HELO: mail-vb0-f42.google.com Received: from mail-vb0-f42.google.com (HELO mail-vb0-f42.google.com) (209.85.212.42) by sourceware.org (qpsmtpd/0.93/v0.84-503-g423c35a) with (AES128-SHA encrypted) ESMTPS; Sat, 08 Feb 2014 05:27:17 +0000 Received: by mail-vb0-f42.google.com with SMTP id i11so152324vbh.1 for ; Fri, 07 Feb 2014 21:27:15 -0800 (PST) X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20130820; h=x-gm-message-state:mime-version:in-reply-to:references:date :message-id:subject:from:to:cc:content-type; bh=rK1dpx8WDOe7M1Vmn9NnlMVwHndEq2xKtjEWcuk/hSE=; b=lH20oIQfnUvF6XYBt0VTeQ237vUdN9gIS7GFebcZAAVMnjJecOhZDVSjjQL7BFNwB2 50TPFsG6bM4qcrHhhP3IAuQeu+E/OxrjTvaVZ04Vk1ohwgJ++WIr1GEPJzqqktAjYoJf +GI95jOoVldIxl8B2+eT1v3ast8Aaxxfi7WoCn5nP1DmtpYwWiwWG8t3qPPP4HgcnwjR EbAcOsTLKdZ31rJHw+D592E4ZIq+ndzWKixD5X4P7Mioytw1HGC3Cej/QTFAgRuN/R9+ NDYbZQlsquwuVtnNJ8Xf+Y360Z+m77IqoGnfcjgpLo2gBx+c3IxRRMN3j11Og9aTPyHD GtOQ== X-Gm-Message-State: ALoCoQkBzbTpOPGiGH68KThCizNfoBVCNoHMwy86rz+qhFEyD65utCwcI2q0aLyRxxFBJDK10h0xxBShtpCKVQhU3Yd0viTXKmTBKhU8HCUW3JfmksMySbaxKRqEAFku+ItJRmeqaAPaQX0AkCOyMsylTxGMrbAXVZk70rO0YrLgOaik3/N4C0K32dL5TCvNU0bHRS43h3D4SAiDmkTdIFE3UuCHybPAGg== MIME-Version: 1.0 X-Received: by 10.58.37.67 with SMTP id w3mr313506vej.22.1391837235192; Fri, 07 Feb 2014 21:27:15 -0800 (PST) Received: by 10.52.51.234 with HTTP; Fri, 7 Feb 2014 21:27:15 -0800 (PST) In-Reply-To: <52F420E0.9050203@earthlink.net> References: <52F420E0.9050203@earthlink.net> Date: Sat, 08 Feb 2014 05:27:00 -0000 Message-ID: Subject: Re: [PATCH] Use Doxygen for internals documentation From: Doug Evans To: Stan Shebs Cc: gdb-patches Content-Type: text/plain; charset=UTF-8 X-IsSubscribed: yes X-SW-Source: 2014-02/txt/msg00240.txt.bz2 On Thu, Feb 6, 2014 at 3:55 PM, Stan Shebs wrote: > Here is the official patch for the introduction of Doxygen that I > proposed last fall. > > This differs from the RFC version in including a filter as > suggested by Pedro, and having an index page that points to the > different sets of pages. > > Among other things, the filter gives us the option of flagging > Doxygen comments with "/* * ", which is lower-impact than the > previous requirement of putting "/**" on a line by itself - in > other words, just adding a " *" to existing comments. > > As before, "cd doc; make doxy" in an objdir creates, then browse > doc/doxy/index.html to connect to everything. > > In the absence of any fatal flaws, I expect to commit this next > week, and then follow up with patches that doxygenate some > representative header files. At some point we'll also want to > add a snapshot-generated set of pages to the website. Awesome!