summaryrefslogtreecommitdiff
path: root/lib
diff options
context:
space:
mode:
authorPaul Kocialkowski <paul.kocialkowski@linux.intel.com>2017-07-20 17:11:52 +0300
committerArkadiusz Hiler <arkadiusz.hiler@intel.com>2017-07-24 13:56:53 +0300
commit76bce77388bcb4f1c0fc8d6245279ec50e12161a (patch)
tree35ef8c6fecfdb28d547cc609dc6eb28a2f129501 /lib
parent9f49776fb4afd48f3f6a307f296c62c6452f229d (diff)
docs: Update documentation generation with missing entries
This adds missing entries for documentation generation, both for tests and the API reference. The list of tests is made complete and ordered alphabetically, with modified descriptions for consistency. More files are added to the API reference, with a minimalistic description block added to them when it was missing. Signed-off-by: Paul Kocialkowski <paul.kocialkowski@linux.intel.com> Reviewed-by: Arkadiusz Hiler <arkadiusz.hiler@intel.com>
Diffstat (limited to 'lib')
-rw-r--r--lib/igt_gvt.c7
-rw-r--r--lib/igt_primes.c7
-rw-r--r--lib/igt_rand.c7
-rw-r--r--lib/igt_x86.c7
-rw-r--r--lib/sw_sync.c7
5 files changed, 35 insertions, 0 deletions
diff --git a/lib/igt_gvt.c b/lib/igt_gvt.c
index 4ab74332..a78e98e9 100644
--- a/lib/igt_gvt.c
+++ b/lib/igt_gvt.c
@@ -31,6 +31,13 @@
#include <unistd.h>
#include <fcntl.h>
+/**
+ * SECTION:igt_gvt
+ * @short_description: Graphics virtualization technology library
+ * @title: GVT
+ * @include: igt_gvt.h
+ */
+
static bool is_gvt_enabled(void)
{
bool enabled = false;
diff --git a/lib/igt_primes.c b/lib/igt_primes.c
index d5232e54..3578a3c6 100644
--- a/lib/igt_primes.c
+++ b/lib/igt_primes.c
@@ -28,6 +28,13 @@
#include <string.h>
#include <math.h>
+/**
+ * SECTION:igt_primes
+ * @short_description: Prime numbers helper library
+ * @title: Primes
+ * @include: igt_primes.h
+ */
+
#define BITS_PER_CHAR 8
#define BITS_PER_LONG (sizeof(long)*BITS_PER_CHAR)
diff --git a/lib/igt_rand.c b/lib/igt_rand.c
index b8d3a92c..664a4764 100644
--- a/lib/igt_rand.c
+++ b/lib/igt_rand.c
@@ -1,5 +1,12 @@
#include "igt_rand.h"
+/**
+ * SECTION:igt_rand
+ * @short_description: Random numbers helper library
+ * @title: Random
+ * @include: igt_rand.h
+ */
+
static uint32_t global = 0x12345678;
uint32_t hars_petruska_f54_1_random_seed(uint32_t new_state)
diff --git a/lib/igt_x86.c b/lib/igt_x86.c
index f40b9a2f..6f03849f 100644
--- a/lib/igt_x86.c
+++ b/lib/igt_x86.c
@@ -40,6 +40,13 @@
#include "igt_x86.h"
#include <stdio.h>
+/**
+ * SECTION:igt_x86
+ * @short_description: x86 helper library
+ * @title: x86
+ * @include: igt_x86.h
+ */
+
#define BASIC_CPUID 0x0
#define EXTENDED_CPUID 0x80000000
diff --git a/lib/sw_sync.c b/lib/sw_sync.c
index c05a7876..7bd76702 100644
--- a/lib/sw_sync.c
+++ b/lib/sw_sync.c
@@ -41,6 +41,13 @@
#include "drmtest.h"
#include "ioctl_wrappers.h"
+/**
+ * SECTION:sw_sync
+ * @short_description: Software sync (fencing) support library
+ * @title: SW Sync
+ * @include: sw_sync.h
+ */
+
struct int_sync_create_fence_data {
__u32 value;
char name[32];