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

Re: [libvirt] [PATCHv2 0/3] Colorize HTML documentation



At Mon, 21 Jan 2013 15:59:12 +0100,
Claudio Bley wrote:
> 
> I did spot a small glitch right after looking at the site, however.
> 
> All the virTypedParams* functions have no documentation attached to
> them. Do you happen to know why this is?

Oh, I see. That's because virtypedparam.c is not processed by
apibuild.py.

If it would be, you get a bunch of error messages about missing
descriptions for arguments and return values among errors about
misformatted function comments. 

Try for yourself:

---- 8< ---- >8 ----
diff --git a/docs/Makefile.am b/docs/Makefile.am
index c95497f..78d72ac 100644
--- a/docs/Makefile.am
+++ b/docs/Makefile.am
@@ -251,7 +251,8 @@ $(APIBUILD_STAMP): $(srcdir)/apibuild.py \
                $(srcdir)/../src/libvirt.c \
                $(srcdir)/../src/libvirt-lxc.c \
                $(srcdir)/../src/libvirt-qemu.c \
-               $(srcdir)/../src/util/virerror.c
+               $(srcdir)/../src/util/virerror.c \
+               $(srcdir)/../src/util/virtypedparam.c
        $(AM_V_GEN)srcdir=$(srcdir) $(PYTHON) $(APIBUILD)
        touch $@

diff --git a/docs/apibuild.py b/docs/apibuild.py
index e24e42d..4d7b002 100755
--- a/docs/apibuild.py
+++ b/docs/apibuild.py
@@ -24,6 +24,7 @@ included_files = {
   "libvirt.h": "header with general libvirt API definitions",
   "virterror.h": "header with error specific API definitions",
   "libvirt.c": "Main interfaces for the libvirt library",
+  "virtypedparam.c": "implements helper functions for typed parameters",
   "virterror.c": "implements error handling and reporting code for libvirt",
   "event.c": "event loop for monitoring file handles",
 }


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