Browse Source

Some documentation improvements in obs.h

A stub for the main documentation page was created.
fryshorts 11 years ago
parent
commit
f0db683d0b
1 changed files with 9 additions and 2 deletions
  1. 9 2
      libobs/obs.h

+ 9 - 2
libobs/obs.h

@@ -63,10 +63,17 @@ typedef struct obs_module     obs_module_t;
 #include "obs-output.h"
 #include "obs-service.h"
 
-/*
+/**
  * @file
+ * @brief Main libobs header used by applications.
+ *
+ * @mainpage
+ *
+ * @section intro_sec Introduction
+ *
+ * This document describes the api for libobs to be used by applications as well
+ * as @ref modules_page implementing some kind of functionality.
  *
- * Main libobs header used by applications.
  */
 
 #ifdef __cplusplus