gbm: Add documentation for the public facing API

1 files changed, 15 insertions, 0 deletions

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;