qemu-devel.nongnu.org archive mirror
 help / color / mirror / Atom feed
From: Stefan Weil <sw@weilnetz.de>
To: Kevin Wolf <kwolf@redhat.com>
Cc: "Avi Kivity" <avi@redhat.com>,
	"Anthony Liguori" <aliguori@us.ibm.com>,
	qemu-devel@nongnu.org, "Andreas Färber" <afaerber@suse.de>
Subject: Re: [Qemu-devel] [PATCH v2 0/4] GTK-DOC build integration (v2)
Date: Sun, 18 Dec 2011 13:00:26 +0100	[thread overview]
Message-ID: <4EEDD5DA.7020401@weilnetz.de> (raw)
In-Reply-To: <4EE9CA37.6040903@redhat.com>

Am 15.12.2011 11:21, schrieb Kevin Wolf:
> Am 15.12.2011 10:32, schrieb Stefan Weil:
>> Am 15.12.2011 06:22, schrieb Andreas Färber:
>>> Their website has the following:
>>>
>>> "GTK-Doc wasn't originally intended to be a general-purpose
>>> documentation tool, so it can be a bit awkward to setup and use. For a
>>> more polished general-purpose documentation tool you may want to look at
>>> Doxygen. However GTK-Doc has some special code to document the signals
>>> and properties of GTK+ widgets and GObject classes which other tools may
>>> not have."
>>> http://www.gtk.org/gtk-doc/
>>>
>>> Don't know if Doxygen has less restrictions though.
>>>
>>> Andreas
>> With doxygen, the documentation looks like this:
>> http://qemu.weilnetz.de/doxygen/
>>
>> I only modified the first lines of memory.h to get
>> the global C functions, but of course more changes
>> are needed if we choose doxygen as our standard.
> You seem to have included Anthony's patches (specifically the one to
> split out nested structs). Is Doxygen really as broken as gtk-doc seems
> to be or can we do without it?
>
> Kevin

Yes, the previous results were based on QEMU with Anthony's
latest gtkdoc patches.

Here is the result from unpatched QEMU code:
http://qemu.weilnetz.de/doxygen2/ or
http://qemu.weilnetz.de/doxygen2/memory_8h.html

I had to remove most graphics because they needed more than
1 GB disk space and filled all available space on my server.

Regards,
Stefan

  reply	other threads:[~2011-12-18 12:01 UTC|newest]

Thread overview: 20+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2011-12-14 20:01 [Qemu-devel] [PATCH v2 0/4] GTK-DOC build integration (v2) Anthony Liguori
2011-12-14 20:01 ` [Qemu-devel] [PATCH v2 1/4] memory: make memory API parsable by gtkdoc-scan (v2) Anthony Liguori
2011-12-15  9:28   ` Kevin Wolf
2011-12-15 13:25     ` Anthony Liguori
2011-12-14 20:01 ` [Qemu-devel] [PATCH v2 2/4] docs: add build infrastructure for gtkdocs (v2) Anthony Liguori
2012-03-12 20:48   ` Eduardo Habkost
2012-03-12 23:37     ` Andreas Färber
2011-12-14 20:01 ` [Qemu-devel] [PATCH v2 3/4] memory: update documentation to be in gtk-doc format Anthony Liguori
2011-12-14 20:01 ` [Qemu-devel] [PATCH v2 4/4] memory: move header into include/ and add to QEMU docs Anthony Liguori
2011-12-14 20:54 ` [Qemu-devel] [PATCH v2 0/4] GTK-DOC build integration (v2) Marc-André Lureau
2011-12-14 21:08   ` Anthony Liguori
2011-12-15  5:22     ` Andreas Färber
2011-12-15  9:32       ` Stefan Weil
2011-12-15 10:04         ` Daniel P. Berrange
2011-12-15 10:29           ` Stefan Weil
2011-12-15 11:36             ` Andreas Färber
2011-12-15 11:46               ` Kevin Wolf
2011-12-15 10:21         ` Kevin Wolf
2011-12-18 12:00           ` Stefan Weil [this message]
2012-03-12 21:03 ` Lluís Vilanova

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=4EEDD5DA.7020401@weilnetz.de \
    --to=sw@weilnetz.de \
    --cc=afaerber@suse.de \
    --cc=aliguori@us.ibm.com \
    --cc=avi@redhat.com \
    --cc=kwolf@redhat.com \
    --cc=qemu-devel@nongnu.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).