Merge pull request #287 from fryshorts/doxygen

Add Doxygen configuration for creating api documentation
2014-10-29 20:41:05 -07:00
parent 10a9133e7c a2472592d4
commit ed51fd0efd
10 changed files with 2559 additions and 9 deletions
--- a/libobs/obs.h
+++ b/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