[libvirt] [PATCH 0/6] API documentation improvements

Claudio Bley cbley at av-test.de
Thu Oct 10 11:13:05 UTC 2013


ping?

At Wed, 25 Sep 2013 08:49:03 +0200,
Claudio Bley wrote:
> 
> Hi.
> 
> It's been a while since I tackled this, but here it goes...
> 
> This is version 4 of https://www.redhat.com/archives/libvir-list/2013-January/msg02094.html
> exclusive of the already applied patches, of course.
> 
> Changes since v3:
> 
>  * skipped the ECMAScript code highlighting patch[1] in this series
>    (postponed for now)
> 
>  * added link generation patch (#6) which I had proposed
>    seperately back in Jan 2013, too.
> 
>  * added a reference to an affected API in patch #1 and #4 as per
>    Eric's comments
> 
>  * changed the code block XSL processing to avoid cutting off characters
>    at the beginning of a line
> 
> [1] https://www.redhat.com/archives/libvir-list/2013-January/msg02104.html
> [2] https://www.redhat.com/archives/libvir-list/2013-January/msg00884.html
> 
> Claudio Bley (6):
>   docs: process code blocks similar to Markdown
>   docs: add class "description" to div's containing descriptions
>   docs: define style of code blocks inside descriptions
>   libvirt.c: add 2 spaces of indentation to example code of
>     virStreamSend
>   libvirt.c: indent code of virDomainGetMemoryParameters's
>     documentation
>   docs: generate links from plain text documentation
> 
>  docs/libvirt.css |    7 +++
>  docs/newapi.xsl  |  121 +++++++++++++++++++++++++++++++++++++++-----------
>  src/libvirt.c    |  130 +++++++++++++++++++++++++++---------------------------
>  3 files changed, 167 insertions(+), 91 deletions(-)
> 
> -- 
> 1.7.9.5
> 
> --
> libvir-list mailing list
> libvir-list at redhat.com
> https://www.redhat.com/mailman/listinfo/libvir-list
> 
-- 
AV-Test GmbH, Henricistraße 20, 04155 Leipzig, Germany
Phone: +49 341 265 310 19
Web:<http://www.av-test.org>

Eingetragen am / Registered at: Amtsgericht Stendal (HRB 114076)
Geschaeftsfuehrer (CEO): Andreas Marx, Guido Habicht, Maik Morgenstern




More information about the libvir-list mailing list