aboutsummaryrefslogtreecommitdiff
path: root/Src/external_dependencies/openmpt-trunk/libopenmpt/dox/index.dox
blob: 4a73d7f14c3223924601c12096bd9fcf8945161a (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43

/*!
 * \mainpage Contents
 *
 * libopenmpt is a cross-platform C++ and C library to decode <a href="https://en.wikipedia.org/wiki/Module_file">tracked music files (modules)</a> into a raw PCM audio stream.
 *
 * libopenmpt is based on the player code of the Open ModPlug Tracker project (OpenMPT, <a href="https://openmpt.org/">https://openmpt.org/</a>)
 *
 * \section toc Contents
 * - \ref md_README "README"
 * - \ref dependencies "Dependencies"
 * - \ref gettingstarted "Getting Started"
 * - \ref packaging "Packaging"
 * - \ref md_doc_contributing "Contributing"
 * - \ref md_doc_libopenmpt_styleguide "libopenmpt Style Guide"
 * - \ref md_doc_openmpt_styleguide "OpenMPT Style Guide"
 * - \ref tests "Tests"
 * - \ref changelog "Changelog"
 * - \ref md_doc_module_formats "Implementing new Module Formats"
 * - <a href="https://bugs.openmpt.org/">Issue Tracker</a>
 * \subsection toc_apis APIs
 * - libopenmpt
 *   - \ref libopenmpt "Common Details"
 * - libopenmpt C++
 *   - \ref libopenmpt_cpp_overview "Overview"
 *   - \ref libopenmpt_cpp "Details"
 * - libopenmpt C
 *   - \ref libopenmpt_c_overview "Overview"
 *   - \ref libopenmpt_c "Details"
 * - libopenmpt_ext C++
 *   - \ref libopenmpt_ext_cpp_overview "Overview"
 *   - \ref libopenmpt_ext_cpp "Details"
 * - libopenmpt_ext C
 *   - \ref libopenmpt_ext_c_overview "Overview"
 *   - \ref libopenmpt_ext_c "Details"
 *
 * \section toc_website Website
 * https://lib.openmpt.org/
 *
 * \section toc_license License
 * \include LICENSE
 *
 */