diff options
| author | Taylor Holberton <taylorcholberton@gmail.com> | 2016-10-01 15:17:33 -0400 |
|---|---|---|
| committer | Taylor Holberton <taylorcholberton@gmail.com> | 2016-10-01 15:17:33 -0400 |
| commit | 1e21aed210e9e1e1bb3383423c21799a93de2064 (patch) | |
| tree | 24e33667867b632bd4df012f18ed6b82ee6ee496 /doxygen | |
| parent | e69b2802d191d6df6beb0a2a59fce435c41ed14a (diff) | |
Added main page for doxygen
Diffstat (limited to 'doxygen')
| -rw-r--r-- | doxygen/Doxyfile | 2 | ||||
| -rw-r--r-- | doxygen/mainpage.h | 10 |
2 files changed, 11 insertions, 1 deletions
diff --git a/doxygen/Doxyfile b/doxygen/Doxyfile index bdb4870..6a3a2d2 100644 --- a/doxygen/Doxyfile +++ b/doxygen/Doxyfile @@ -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 diff --git a/doxygen/mainpage.h b/doxygen/mainpage.h new file mode 100644 index 0000000..9b300f2 --- /dev/null +++ b/doxygen/mainpage.h @@ -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>. + */ + |