lib: various documentation fixes

Signed-off-by: Thomas Wood <thomas.wood@intel.com>

14 files changed, 16 insertions, 15 deletions

diff --git a/lib/drmtest.c b/lib/drmtest.c
index ee5c1232..46b6618a 100644
--- a/lib/drmtest.c
+++ b/lib/drmtest.c
@@ -62,7 +62,7 @@
  * SECTION:drmtest
  * @short_description: Base library for drm tests and tools
  * @title: drmtest
- * @include: drmtest.h
+ * @include: igt.h
  *
  * This library contains the basic support for writing tests, with the most
  * important part being the helper function to open drm device nodes.
diff --git a/lib/igt_aux.c b/lib/igt_aux.c
index 20e7c422..c26d167d 100644
--- a/lib/igt_aux.c
+++ b/lib/igt_aux.c
@@ -63,7 +63,7 @@
  * SECTION:igt_aux
  * @short_description: Auxiliary libraries and support functions
  * @title: aux
- * @include: igt_aux.h
+ * @include: igt.h
  *
  * This library provides various auxiliary helper functions that don't really
  * fit into any other topic.
diff --git a/lib/igt_core.c b/lib/igt_core.c
index c70176fb..129476c9 100644
--- a/lib/igt_core.c
+++ b/lib/igt_core.c
@@ -75,7 +75,7 @@
  * SECTION:igt_core
  * @short_description: Core i-g-t testing support
  * @title: Core
- * @include: igt_core.h
+ * @include: igt.h
  *
  * This library implements the core of the i-g-t test support infrastructure.
  * Main features are the subtest enumeration, cmdline option parsing helpers for
@@ -1794,7 +1794,7 @@ void igt_set_timeout(unsigned int seconds,
 }
 
 /**
- * igt_reset_timeout - reset timeout to default
+ * igt_reset_timeout:
  *
  * This function resets a timeout set by igt_set_timeout() and disables any
  * timer set up by the former function.
diff --git a/lib/igt_debugfs.c b/lib/igt_debugfs.c
index 3cbc981d..5c132795 100644
--- a/lib/igt_debugfs.c
+++ b/lib/igt_debugfs.c
@@ -43,7 +43,7 @@
  * SECTION:igt_debugfs
  * @short_description: Support code for debugfs features
  * @title: debugfs
- * @include: igt_debugfs.h
+ * @include: igt.h
  *
  * This library provides helpers to access debugfs features. On top of some
  * basic functions to access debugfs files with e.g. igt_debugfs_open() it also
diff --git a/lib/igt_draw.c b/lib/igt_draw.c
index 760bda8c..38ecae0f 100644
--- a/lib/igt_draw.c
+++ b/lib/igt_draw.c
@@ -36,7 +36,7 @@
  * SECTION:igt_draw
  * @short_description: drawing helpers for tests
  * @title: Draw
- * @include: igt_draw.h
+ * @include: igt.h
  *
  * This library contains some functions for drawing rectangles on buffers using
  * the many different drawing methods we have. It also contains some wrappers
diff --git a/lib/igt_fb.c b/lib/igt_fb.c
index 134dbd25..1234ed92 100644
--- a/lib/igt_fb.c
+++ b/lib/igt_fb.c
@@ -37,7 +37,7 @@
  * SECTION:igt_fb
  * @short_description: Framebuffer handling and drawing library
  * @title: Framebuffer
- * @include: igt_fb.h
+ * @include: igt.h
  *
  * This library contains helper functions for handling kms framebuffer objects
  * using #igt_fb structures to track all the metadata.  igt_create_fb() creates
diff --git a/lib/igt_gt.c b/lib/igt_gt.c
index 8e5e076a..c181e433 100644
--- a/lib/igt_gt.c
+++ b/lib/igt_gt.c
@@ -41,7 +41,7 @@
  * SECTION:igt_gt
  * @short_description: GT support library
  * @title: GT
- * @include: igt_gt.h
+ * @include: igt.h
  *
  * This library provides various auxiliary helper functions to handle general
  * interactions with the GT like forcewake handling, injecting hangs or stopping
diff --git a/lib/igt_kms.c b/lib/igt_kms.c
index 0bb16b4e..0d45f452 100644
--- a/lib/igt_kms.c
+++ b/lib/igt_kms.c
@@ -166,7 +166,7 @@ const unsigned char* igt_kms_get_base_edid(void)
  * SECTION:igt_kms
  * @short_description: Kernel modesetting support library
  * @title: KMS
- * @include: igt_kms.h
+ * @include: igt.h
  *
  * This library provides support to enumerate and set modeset configurations.
  *
diff --git a/lib/igt_stats.c b/lib/igt_stats.c
index 55dea0c2..78db6be1 100644
--- a/lib/igt_stats.c
+++ b/lib/igt_stats.c
@@ -38,7 +38,7 @@
  * SECTION:igt_stats
  * @short_description: Tools for statistical analysis
  * @title: Stats
- * @include: igt_stats.h
+ * @include: igt.h
  *
  * Various tools to make sense of data.
  *
diff --git a/lib/igt_stats.h b/lib/igt_stats.h
index 0dc065f4..ec898b24 100644
--- a/lib/igt_stats.h
+++ b/lib/igt_stats.h
@@ -30,7 +30,8 @@
 
 /**
  * igt_stats_t:
- * @values: An array containing the pushed values
+ * @values_u64: An array containing pushed integer values
+ * @values_f: An array containing pushed float values
  * @n_values: The number of pushed values
  */
 typedef struct {
diff --git a/lib/intel_batchbuffer.c b/lib/intel_batchbuffer.c
index 0fa47d86..692521fd 100644
--- a/lib/intel_batchbuffer.c
+++ b/lib/intel_batchbuffer.c
@@ -49,7 +49,7 @@
  * SECTION:intel_batchbuffer
  * @short_description: Batchbuffer and blitter support
  * @title: Batch Buffer
- * @include: intel_batchbuffer.h
+ * @include: igt.h
  *
  * This library provides some basic support for batchbuffers and using the
  * blitter engine based upon libdrm. A new batchbuffer is allocated with
diff --git a/lib/intel_chipset.c b/lib/intel_chipset.c
index 7ac2d1f0..0e5b016c 100644
--- a/lib/intel_chipset.c
+++ b/lib/intel_chipset.c
@@ -45,7 +45,7 @@
  * SECTION:intel_chipset
  * @short_description: Feature macros and chipset helpers
  * @title: Chipset
- * @include: intel_chipset.h
+ * @include: igt.h
  *
  * This library mostly provides feature macros which use raw pci device ids. It
  * also provides a few more helper functions to handle pci devices, chipset
diff --git a/lib/intel_mmio.c b/lib/intel_mmio.c
index e5e23c3d..4981daf9 100644
--- a/lib/intel_mmio.c
+++ b/lib/intel_mmio.c
@@ -50,7 +50,7 @@
  * SECTION:intel_io
  * @short_description: Register access and sideband I/O library
  * @title: I/O
- * @include: intel_io.h
+ * @include: igt.h
  * @section_id: intel-gpu-tools-IO
  *
  * This library provides register I/O helpers in both a basic version and a more
diff --git a/lib/ioctl_wrappers.c b/lib/ioctl_wrappers.c
index 53bd635d..80e1ec6e 100644
--- a/lib/ioctl_wrappers.c
+++ b/lib/ioctl_wrappers.c
@@ -62,7 +62,7 @@
  * SECTION:ioctl_wrappers
  * @short_description: ioctl wrappers and related functions
  * @title: ioctl wrappers
- * @include: ioctl_wrappers.h
+ * @include: igt.h
  *
  * This helper library contains simple functions to wrap the raw drm/i915 kernel
  * ioctls. The normal versions never pass any error codes to the caller and use