From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from eggs.gnu.org ([2001:4830:134:3::10]:49103) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1WKm7I-0006xb-La for qemu-devel@nongnu.org; Tue, 04 Mar 2014 04:58:37 -0500 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1WKm7A-0006zw-7t for qemu-devel@nongnu.org; Tue, 04 Mar 2014 04:58:28 -0500 Received: from mail-pd0-x22f.google.com ([2607:f8b0:400e:c02::22f]:62023) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1WKm7A-0006zp-0c for qemu-devel@nongnu.org; Tue, 04 Mar 2014 04:58:20 -0500 Received: by mail-pd0-f175.google.com with SMTP id x10so4893194pdj.6 for ; Tue, 04 Mar 2014 01:58:18 -0800 (PST) Message-ID: <5315A3B5.4040805@gmail.com> Date: Tue, 04 Mar 2014 17:58:13 +0800 From: Xuebing wang MIME-Version: 1.0 References: <1393901250-3922-1-git-send-email-xbing6@gmail.com> <1393901250-3922-2-git-send-email-xbing6@gmail.com> <20140304094244.GH25676@stefanha-thinkpad.redhat.com> In-Reply-To: <20140304094244.GH25676@stefanha-thinkpad.redhat.com> Content-Type: text/plain; charset=ISO-8859-1; format=flowed Content-Transfer-Encoding: 7bit Subject: Re: [Qemu-devel] [Discussion 01/10] docs: add docs/api-hierarchy.txt List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , To: Stefan Hajnoczi Cc: pbonzini@redhat.com, qemu-devel@nongnu.org, stefanha@redhat.com, afaerber@suse.de On 03/04/2014 05:42 PM, Stefan Hajnoczi wrote: > On Tue, Mar 04, 2014 at 10:47:21AM +0800, Xuebing Wang wrote: >> Signed-off-by: Xuebing Wang >> --- >> docs/api-hierarchy.txt | 93 ++++++++++++++++++++++++++++++++++++++++++++++++ >> 1 file changed, 93 insertions(+) >> create mode 100644 docs/api-hierarchy.txt > This type of documentation gets outdated really quickly. I'm not sure > it should be merged. > > Documenting the various APIs as doc comments in the code would have a > better chance of staying up-to-date. > Thanks. But, doc comments in the code don't show the hierarchy and their dependencies (or inheriting relationship). Any idea how to draw the hierarchy to show the big picture of the APIs (as a high-level API design doc)? :-) -- Thanks, Xuebing Wang