igt/ioctls: doc for gem_mmap

Just spotted while driving around. gtkdoc needs the full parameter
list otherwise it doesn't recognize it as a function. So add them.

Signed-off-by: Daniel Vetter <daniel.vetter@ffwll.ch>
This commit is contained in:
Daniel Vetter 2015-02-06 11:06:11 +01:00
parent a3e34ce258
commit 15801b4dad

View File

@ -78,10 +78,19 @@ void *gem_mmap__wc(int fd, uint32_t handle, int offset, int size, int prot);
/** /**
* gem_mmap: * gem_mmap:
* @fd: open i915 drm file descriptor
* @handle: gem buffer object handle
* @size: size of the gem buffer
* @prot: memory protection bits as used by mmap()
*
* This functions wraps up procedure to establish a memory mapping through the
* GTT.
* *
* This is a simple convenience alias to gem_mmap__gtt() * This is a simple convenience alias to gem_mmap__gtt()
*
* Returns: A pointer to the created memory mapping.
*/ */
#define gem_mmap gem_mmap__gtt #define gem_mmap(fd, handle, size, prot) gem_mmap__gtt(fd, handle, size, prot)
int gem_madvise(int fd, uint32_t handle, int state); int gem_madvise(int fd, uint32_t handle, int state);