mirror of
https://github.com/tiagovignatti/intel-gpu-tools.git
synced 2025-06-23 15:56:33 +00:00
lib: various documentation fixes
Signed-off-by: Thomas Wood <thomas.wood@intel.com>
This commit is contained in:
parent
de2470ea4f
commit
f0381d1abe
@ -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.
|
||||
|
@ -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.
|
||||
|
@ -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.
|
||||
|
@ -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
|
||||
|
@ -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
|
||||
|
@ -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
|
||||
|
@ -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
|
||||
|
@ -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.
|
||||
*
|
||||
|
@ -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.
|
||||
*
|
||||
|
@ -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 {
|
||||
|
@ -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
|
||||
|
@ -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
|
||||
|
@ -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
|
||||
|
@ -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
|
||||
|
Loading…
x
Reference in New Issue
Block a user