From mboxrd@z Thu Jan  1 00:00:00 1970
Return-Path: <gdb-patches-return-106425-listarch-gdb-patches=sources.redhat.com@sourceware.org>
Received: (qmail 27584 invoked by alias); 17 Oct 2013 20:23:01 -0000
Mailing-List: contact gdb-patches-help@sourceware.org; run by ezmlm
Precedence: bulk
List-Id: <gdb-patches.sourceware.org>
List-Subscribe: <mailto:gdb-patches-subscribe@sourceware.org>
List-Archive: <http://sourceware.org/ml/gdb-patches/>
List-Post: <mailto:gdb-patches@sourceware.org>
List-Help: <mailto:gdb-patches-help@sourceware.org>, <http://sourceware.org/ml/#faqs>
Sender: gdb-patches-owner@sourceware.org
Received: (qmail 27572 invoked by uid 89); 17 Oct 2013 20:23:00 -0000
Authentication-Results: sourceware.org; auth=none
X-Virus-Found: No
X-Spam-SWARE-Status: No, score=-3.6 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; Thu, 17 Oct 2013 20:23:00 +0000
Received: from int-mx09.intmail.prod.int.phx2.redhat.com (int-mx09.intmail.prod.int.phx2.redhat.com [10.5.11.22])	by mx1.redhat.com (8.14.4/8.14.4) with ESMTP id r9HKMuYp013979	(version=TLSv1/SSLv3 cipher=DHE-RSA-AES256-SHA bits=256 verify=OK);	Thu, 17 Oct 2013 16:22:57 -0400
Received: from barimba (ovpn-113-54.phx2.redhat.com [10.3.113.54])	by int-mx09.intmail.prod.int.phx2.redhat.com (8.14.4/8.14.4) with ESMTP id r9HKMtms001629	(version=TLSv1/SSLv3 cipher=DHE-RSA-AES128-SHA bits=128 verify=NO);	Thu, 17 Oct 2013 16:22:56 -0400
From: Tom Tromey <tromey@redhat.com>
To: Stan Shebs <stanshebs@earthlink.net>
Cc: gdb-patches@sourceware.org
Subject: Re: [RFC] Use Doxygen for internals documentation
References: <525877F6.40001@earthlink.net> <87bo2pw2fj.fsf@fleche.redhat.com>	<525EEE76.3080900@earthlink.net>
Date: Thu, 17 Oct 2013 20:23:00 -0000
In-Reply-To: <525EEE76.3080900@earthlink.net> (Stan Shebs's message of "Wed,	16 Oct 2013 12:52:22 -0700")
Message-ID: <87wqlbtzog.fsf@fleche.redhat.com>
User-Agent: Gnus/5.13 (Gnus v5.13) Emacs/24.3 (gnu/linux)
MIME-Version: 1.0
Content-Type: text/plain
X-SW-Source: 2013-10/txt/msg00538.txt.bz2

>>>>> "Stan" == Stan Shebs <stanshebs@earthlink.net> writes:

[...]
Stan> Yeah, I think real deployment entails some kind of top-level page that
Stan> is the overall guide.

Thanks for the responses.
I'm on board.

Stan> Another, more incremental approach is to have the API doxyfile list only
Stan> the files that have doxygen-type documentation.  So one grows
Stan> the doxyfile as more files get documented, and if foo-tdep.h never
Stan> gets official documentation, it's never clutter in the listing.

This sounds like a good default to me.

Tom