[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]

[libvirt] [PATCH v3 00/13] documentation improvements, code blocks with syntax highlighting



Hi.

This is version 3 of
https://www.redhat.com/archives/libvir-list/2013-January/msg02026.html
combined with pre-requisite patches from
https://www.redhat.com/archives/libvir-list/2013-January/msg02071.html

Summary of the changes:

- patch #1 to #4 are adding / fixing missing documentation,
  which is required so the next patch does not break the build
- patch #5 aborts the build when documentation is missing for
  function arguments or the return value, except for those functions
  being part of the "ignored_functions" dictionary
- patch #11 also adds an exception to syntax rules for the
  generated SHJS files
- patch #12, #13 just add some indentation to make code blocks
  properly recognized

This time, I did use make check and make syntax-check after every
patch, so this should be OK. (fingers crossed)

Claudio Bley (13):
  libvirt.h.in: add missing documentation for virConnectCloseFunc
  libvirt.h.in: fix documentation for
    virConnectDomainEventBlockJobCallback
  libvirt.h.in: add missing return doc for virEventRemoveHandleFunc
  libvirt.h.in: document virConnectDomainEventCallback's return value
  docs: abort when missing return or argument documentation
  docs: only generate function argument info for args with a
    description
  docs: use div, not table, for notices on opaque types
  docs: process code blocks similar to markdown
  docs: add class "description" to div's containing descriptions
  docs: define style of code blocks inside descriptions
  docs: syntax highlight code blocks using SHJS
  libvirt.c: indent code of virDomainGetMemoryParameters's
    documentation
  libvirt.c: add 2 spaces of indentation to example code

 cfg.mk                       |    2 +-
 docs/apibuild.py             |   18 +++-
 docs/libvirt.css             |    8 ++
 docs/newapi.xsl              |  209 +++++++++++++++++++++++++-----------------
 docs/page.xsl                |    5 +-
 docs/sh_c.min.js             |    1 +
 docs/sh_emacs.min.css        |    1 +
 docs/sh_main.min.js          |    4 +
 include/libvirt/libvirt.h.in |   16 +++-
 src/libvirt.c                |  130 +++++++++++++-------------
 10 files changed, 241 insertions(+), 153 deletions(-)
 create mode 100644 docs/sh_c.min.js
 create mode 100644 docs/sh_emacs.min.css
 create mode 100644 docs/sh_main.min.js

-- 
1.7.9.5


[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]