From baab68e1a607b818c8988e70546fe3e6f97cf572 Mon Sep 17 00:00:00 2001
From: Rob Bradford <rob@linux.intel.com>
Date: Tue, 20 Dec 2011 15:40:21 +0000
Subject: gbm: Add documentation for the public facing API

---
 src/gbm/main/gbmint.h | 15 +++++++++++++++
 1 file changed, 15 insertions(+)

(limited to 'src/gbm/main/gbmint.h')

diff --git a/src/gbm/main/gbmint.h b/src/gbm/main/gbmint.h
index fb8db804c1b..9e4072ef6ea 100644
--- a/src/gbm/main/gbmint.h
+++ b/src/gbm/main/gbmint.h
@@ -38,6 +38,16 @@
 #define GBM_EXPORT
 #endif
 
+/**
+ * \file gbmint.h
+ * \brief Internal implementation details of gbm
+ */
+
+/**
+ * The device used for the memory allocation.
+ *
+ * The members of this structure should be not accessed directly
+ */
 struct gbm_device {
    /* Hack to make a gbm_device detectable by its first element. */
    struct gbm_device *(*dummy)(int);
@@ -63,6 +73,11 @@ struct gbm_device {
    void (*bo_destroy)(struct gbm_bo *bo);
 };
 
+/**
+ * The allocated buffer object.
+ *
+ * The members in this structure should not be accessed directly.
+ */
 struct gbm_bo {
    struct gbm_device *gbm;
    uint32_t width;
-- 
cgit v1.2.3