Re: [Qemu-devel] [Discussion 01/10] docs: add docs/api-hierarchy.txt

[Xuebing wang]

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 <address@hidden>
> > ---
> >   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