Document st_module.

1 files changed, 8 insertions, 0 deletions

diff --git a/st_api.h b/st_api.h
index f7fa9d8..4bfe947 100644
--- a/st_api.h
+++ b/st_api.h
@@ -42,6 +42,9 @@
  * tracker managers.
  */
 
+/**
+ * The entry points of the state trackers.
+ */
 #define ST_MODULE_OPENGL      "st_module_OpenGL"
 #define ST_MODULE_OPENGL_ES1  "st_module_OpenGL_ES1"
 #define ST_MODULE_OPENGL_ES2  "st_module_OpenGL_ES2"
@@ -315,6 +318,11 @@ struct st_api
    void (*destroy)(struct st_api *api);
 };
 
+/**
+ * Represent a state tracker.
+ *
+ * This is the entry point of a state tracker.
+ */
 struct st_module
 {
    struct st_api *(*create_api)(const struct sm_api *smapi);