libvirt/docs
Michal Privoznik 0f1a0fff0e apibuild: Disallow 'returns' return description
Our documentation generator is a bit messy, to say the least. For
instance, the description to return values of a function is
searched within C comment. Currently, all lines that start with
'returns' or 'Returns' are viewed as return value description.
However, there are some valid uses where the 'returns' word is in
the middle of a sentence describing function behavior not the
return value. And there are no places where 'returns' is used to
describe return values.  For instance:
virDomainDetachDeviceFlags, virConnectNetworkEventRegisterAny and
virDomainGetDiskErrors. This leads to HTML documemtation being
generated incorrectly.

Signed-off-by: Michal Privoznik <mprivozn@redhat.com>
2014-05-13 08:51:11 +02:00
..
api_extension
devhelp
html
internals util: fix a typo in virprocess.c and docs 2014-03-27 06:58:46 -06:00
schemas conf: Output disk backing store details in domain XML 2014-04-24 16:06:13 +02:00
32favicon.png
404.html.in
acl.html.in
aclpolkit.html.in
api_extension.html.in maint: improve VIR_ERR_INVALID_CONN usage 2014-01-06 21:41:02 -07:00
api.html.in Fix typos in various docs 2013-12-02 10:21:26 +08:00
apibuild.py apibuild: Disallow 'returns' return description 2014-05-13 08:51:11 +02:00
apps.html.in docs: mention vagrant-libvirt in apps.html 2014-05-12 15:50:59 -06:00
archdomain.html.in
architecture.fig Remove trailing whitespace from all xfig files 2011-10-28 10:11:16 +01:00
architecture.gif
architecture.html.in
archnetwork.html.in
archnode.html.in
archstorage.html.in
auditlog.html.in docs: fix some typos 2013-12-02 11:59:18 -07:00
auth.html.in
bindings.html.in
bugs.html.in Fix typos in various docs 2013-12-02 10:21:26 +08:00
cgroups.html.in docs: cgroups: fix typo about LXC cgroups 2014-03-27 06:52:20 -06:00
compiling.html.in
contact.html.in
csharp.html.in
deployment.html.in
devguide.html.in
docs.html.in
downloads.html.in docs: mention maintenance branches 2014-01-15 09:12:25 -07:00
drivers.html.in bhyve: add basic documentation 2014-03-01 23:44:58 +04:00
drvbhyve.html.in docs: document nmdm type console 2014-04-24 19:57:11 +04:00
drvesx.html.in typos: fix s/it/is/ where applicable 2014-05-05 11:49:36 +02:00
drvhyperv.html.in
drvlxc.html.in LXC: added some doc on domxml-from-native with mention of limitations 2014-02-12 17:52:47 +00:00
drvopenvz.html.in Fix multiple formatting problems in HTML docs 2013-05-03 15:56:15 +01:00
drvparallels.html.in Fix multiple formatting problems in HTML docs 2013-05-03 15:56:15 +01:00
drvphyp.html.in
drvqemu.html.in
drvremote.html.in
drvtest.html.in
drvuml.html.in docs: typo fix 2014-03-03 17:41:26 +04:00
drvvbox.html.in
drvvmware.html.in
drvxen.html.in
errors.html.in
et.png
firewall.html.in Fix typos in various docs 2013-12-02 10:21:26 +08:00
footer_corner.png
footer_pattern.png
format.html.in
formatcaps.html.in
formatdomain.html.in update documentation of <interface type='hostdev'> 2014-05-12 14:52:50 -06:00
formatnetwork.html.in docs: document that vfio is default for hostdev networks too 2014-04-18 16:42:04 +03:00
formatnode.html.in docs: fix usb node device sub-element names 2013-08-15 11:40:50 +02:00
formatnwfilter.html.in nwfilter: Add ARP src/dst IP mask for ebtables ARP 2014-03-13 18:30:09 -04:00
formatsecret.html.in docs: remove <auth> from secret XML format 2014-02-14 16:47:14 +01:00
formatsnapshot.html.in qemu: snapshot: Add support for external active snapshots on gluster 2014-02-14 11:07:29 +01:00
formatstorage.html.in doc: storage: Explicitly state that it's possible to have non-unique key 2014-03-05 09:51:24 +01:00
formatstorageencryption.html.in
genaclperms.pl Add documentation for access control system 2013-08-09 17:13:02 +01:00
generic.css
goals.html.in
governance.html.in Fix minor typo in governance doc 2014-02-04 10:43:15 -07:00
hacking1.xsl
hacking2.xsl
hacking.html.in Add a rule for indenting labels 2014-03-25 14:58:41 +01:00
hooks.html.in network: Introduce network hooks 2014-02-18 14:46:49 +01:00
hvsupport.pl
index.html.in bhyve: add basic documentation 2014-03-01 23:44:58 +04:00
index.py
internals.html.in
intro.html.in
java.html.in
library.xen remove all trailing blank lines 2009-07-16 15:06:42 +02:00
libvirt-daemon-arch.fig
libvirt-daemon-arch.png
libvirt-driver-arch.fig
libvirt-driver-arch.png
libvirt-header-bg.png
libvirt-header-logo.png
libvirt-net-logical.fig
libvirt-net-logical.png
libvirt-net-physical.fig
libvirt-net-physical.png
libvirt-object-model.fig
libvirt-object-model.png
libvirt-virConnect-example.fig
libvirt-virConnect-example.png
libvirt.css docs: add a permalink to html headers 2014-01-27 08:42:09 +01:00
libvirtLogo404.png
libvirtLogo.png
locking.html.in
logging.html.in Remove global log buffer feature entirely 2014-03-18 14:29:22 +00:00
madeWith.png
main.css
Makefile.am
migration-managed-direct.fig
migration-managed-direct.png
migration-managed-p2p.fig
migration-managed-p2p.png
migration-native.fig
migration-native.png
migration-tunnel.fig
migration-tunnel.png
migration-unmanaged-direct.fig
migration-unmanaged-direct.png
migration.html.in
newapi.xsl
news.html.in Release of libvirt-1.2.4 2014-05-04 14:41:29 +08:00
news.xsl
node.fig
node.gif
page.xsl docs/page.xls: remove unnecessary namespace attribute 2014-01-30 15:37:38 +01:00
pending.html.in
php.html.in
python.html.in
relatedlinks.html.in
remote.html.in Fix typos in various docs 2013-12-02 10:21:26 +08:00
search.php.code.in
search.php.in
secureusage.html.in
securityprocess.html.in Fix three minor typos 2013-11-26 18:37:09 +08:00
site.xsl
sitemap.html.in bhyve: add basic documentation 2014-03-01 23:44:58 +04:00
storage.html.in gluster: Fix "key" attribute for gluster volumes 2014-04-01 08:44:34 +02:00
structures.fig
subsite.xsl
testapi.html.in
testsuites.html.in
testtck.html.in
todo.cfg-example
todo.pl
uri.html.in
virshcmdref.html.in
windows.html.in
wrapstring.xsl