gbm: Add documentation for the public facing API

[mesa.git] / src / gbm / main / gbmint.h

diff --git a/src/gbm/main/gbmint.h b/src/gbm/main/gbmint.h
index fb8db804c1b2690037921c2efc8eff84c7ded6fe..9e4072ef6ea60e47a052390f8afbb50c3545a512 100644 (file)
--- 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;