1
0

index.dox 1.5 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243
  1. /*!
  2. * \mainpage Contents
  3. *
  4. * 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.
  5. *
  6. * libopenmpt is based on the player code of the Open ModPlug Tracker project (OpenMPT, <a href="https://openmpt.org/">https://openmpt.org/</a>)
  7. *
  8. * \section toc Contents
  9. * - \ref md_README "README"
  10. * - \ref dependencies "Dependencies"
  11. * - \ref gettingstarted "Getting Started"
  12. * - \ref packaging "Packaging"
  13. * - \ref md_doc_contributing "Contributing"
  14. * - \ref md_doc_libopenmpt_styleguide "libopenmpt Style Guide"
  15. * - \ref md_doc_openmpt_styleguide "OpenMPT Style Guide"
  16. * - \ref tests "Tests"
  17. * - \ref changelog "Changelog"
  18. * - \ref md_doc_module_formats "Implementing new Module Formats"
  19. * - <a href="https://bugs.openmpt.org/">Issue Tracker</a>
  20. * \subsection toc_apis APIs
  21. * - libopenmpt
  22. * - \ref libopenmpt "Common Details"
  23. * - libopenmpt C++
  24. * - \ref libopenmpt_cpp_overview "Overview"
  25. * - \ref libopenmpt_cpp "Details"
  26. * - libopenmpt C
  27. * - \ref libopenmpt_c_overview "Overview"
  28. * - \ref libopenmpt_c "Details"
  29. * - libopenmpt_ext C++
  30. * - \ref libopenmpt_ext_cpp_overview "Overview"
  31. * - \ref libopenmpt_ext_cpp "Details"
  32. * - libopenmpt_ext C
  33. * - \ref libopenmpt_ext_c_overview "Overview"
  34. * - \ref libopenmpt_ext_c "Details"
  35. *
  36. * \section toc_website Website
  37. * https://lib.openmpt.org/
  38. *
  39. * \section toc_license License
  40. * \include LICENSE
  41. *
  42. */