Added main page for doxygen

This commit is contained in:
Taylor Holberton
2016-10-01 15:17:33 -04:00
parent e69b2802d1
commit 1e21aed210
2 changed files with 11 additions and 1 deletions
+1 -1
View File
@@ -771,7 +771,7 @@ WARN_LOGFILE =
# spaces. See also FILE_PATTERNS and EXTENSION_MAPPING
# Note: If this tag is empty the current directory is searched.
INPUT = "../src" "../include/tinyalsa"
INPUT = "./mainpage.h" "../src" "../include/tinyalsa"
# This tag can be used to specify the character encoding of the source files
# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
+10
View File
@@ -0,0 +1,10 @@
/** @mainpage Preamble
*
* Welcome to the documentation for the TinyALSA project.
* <br><br>
* To start, you may either view the @ref pcm or @ref mixer.
* <br><br>
* If you find an error in the documentation or an area for improvement,
* open an issue or send a pull request to the <a href="https://github.com/tinyalsa/tinyalsa">github page</a>.
*/