cog/Frameworks/OpenMPT.old/OpenMPT/libopenmpt/dox/index.dox

43 lines
1.4 KiB
Plaintext

/*!
* \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 quickstart "Quick Start"
* - \ref md_README "README"
* - \ref dependencies "Dependencies"
* - \ref packaging "Packaging"
* - \ref md_doc_contributing "Contributing"
* - \ref md_doc_libopenmpt_styleguide "Style Guide"
* - \ref tests "Tests"
* - \ref changelog "Changelog"
* - \ref md_doc_module_formats "Implementing new Module Formats"
* - \ref todo "TODO"
* \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
*
*/