diff options
author | Daniel Vetter <daniel.vetter@ffwll.ch> | 2014-03-26 15:15:49 +0100 |
---|---|---|
committer | Daniel Vetter <daniel.vetter@ffwll.ch> | 2014-03-26 18:50:28 +0100 |
commit | c6c2b2bb7039e8cc89841bd9782a61b7d734dfe2 (patch) | |
tree | 84cd68f4e9bfd4535f6281e8ecdcc95d258da0c1 /lib | |
parent | 64401f57e958998d537ff67525d5f1e9a4f76b22 (diff) |
lib/igt_kms/bf: doc skeleton
igt_kms docs are just skeleton and also added igt_fb to make sure the
linking works correctly.
Next up: Actually documenting igt_fb.
Also fix that depency spelling fumble I've copied around to a few too
many places.
Signed-off-by: Daniel Vetter <daniel.vetter@ffwll.ch>
Diffstat (limited to 'lib')
-rw-r--r-- | lib/drmtest.c | 2 | ||||
-rw-r--r-- | lib/igt_fb.c | 7 | ||||
-rw-r--r-- | lib/igt_kms.c | 14 | ||||
-rw-r--r-- | lib/intel_batchbuffer.c | 2 |
4 files changed, 23 insertions, 2 deletions
diff --git a/lib/drmtest.c b/lib/drmtest.c index d48af9c8..b1bf5892 100644 --- a/lib/drmtest.c +++ b/lib/drmtest.c @@ -70,7 +70,7 @@ * But there's also a bit of other assorted stuff here. * * Note that this library's header pulls in the [i-g-t core](intel-gpu-tools-i-g-t-core.html) - * and [batchbuffer](intel-gpu-tools-intel-batchbuffer.html) libraries as depencies. + * and [batchbuffer](intel-gpu-tools-intel-batchbuffer.html) libraries as dependencies. */ static int diff --git a/lib/igt_fb.c b/lib/igt_fb.c index 9cbfe646..5e7c7890 100644 --- a/lib/igt_fb.c +++ b/lib/igt_fb.c @@ -33,6 +33,13 @@ #include "igt_fb.h" #include "ioctl_wrappers.h" +/** + * SECTION:igt_fb + * @short_description: Framebuffer handling and drawing library + * @title: i-g-t framebuffer + * @include: igt_fb.h + */ + /* drm fourcc/cairo format maps */ #define DF(did, cid, _bpp, _depth) \ { DRM_FORMAT_##did, CAIRO_FORMAT_##cid, # did, _bpp, _depth } diff --git a/lib/igt_kms.c b/lib/igt_kms.c index 678cf391..9dee855c 100644 --- a/lib/igt_kms.c +++ b/lib/igt_kms.c @@ -42,6 +42,20 @@ #include "igt_kms.h" #include "igt_aux.h" +/** + * SECTION:igt_kms + * @short_description: Kernel modesetting support library + * @title: i-g-t kms + * @include: igt_kms.h + * + * This library provides support to enumerate and set modeset configurations. + * + * Since this library is very much still a work-in-progress and the interfaces + * still in-flux detailed api documentation is currently still missing. + * + * Note that this library's header pulls in the [i-g-t framebuffer](intel-gpu-tools-i-g-t-framebuffer.html) + * library as a dependency. + */ const char *kmstest_pipe_str(int pipe) { diff --git a/lib/intel_batchbuffer.c b/lib/intel_batchbuffer.c index 0d583c73..e8689228 100644 --- a/lib/intel_batchbuffer.c +++ b/lib/intel_batchbuffer.c @@ -58,7 +58,7 @@ * #OUT_BATCH, #OUT_RELOC and #ADVANCE_BATCH. * * Note that this library's header pulls in the [i-g-t core](intel-gpu-tools-i-g-t-core.html) - * library as a depency. + * library as a dependency. */ /** |