Skip to content

Commit

Permalink
Update Doxygen documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
Dasaav-dsv committed May 13, 2024
1 parent 145f30e commit 6b93ea5
Show file tree
Hide file tree
Showing 3 changed files with 21 additions and 0 deletions.
6 changes: 6 additions & 0 deletions docs/Changelog.dox
Original file line number Diff line number Diff line change
Expand Up @@ -31,4 +31,10 @@
* - play_system_sound and play_character_sound, restructure sound playback
* - Simplify sound playback example
*
* ## Version 0.1.4.0:
* - Add runtime param manipulation based on a pull request by <a href="https://github.com/ThomasJClark">ThomasJClark</a>
* - Add 186 param tables with iterator support
* - Autogenerate paramdef headers with ParamStructGenerator by <a href="https://github.com/tremwil">tremwil</a> and <a href="https://github.com/Nordgaren">Nordgaren</a>
* - Add paramdef Doxygen documentation based on Nordgaren's translations
*
*/
7 changes: 7 additions & 0 deletions docs/MainPage.dox
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,13 @@
* @see **EXAMPLES**: @ref example_d3d12_page
* @see draw.hpp
*
* - @link param.hpp Runtime Param Management @endlink: read/write access to all
* param tables used by **ELDEN RING**, with full iterator support, paramdef layouts,
* type safety and field documentation (thanks ThomasJClark and Nordgaren!).
* @see **EXAMPLES**: @ref example_param_page
* @see param.hpp
* @see cs_param.hpp
*
* - @link from_allocator.hpp Memory Allocation@endlink: **libER** documents the
* **ELDEN RING** allocation implementation, and replaces it with a modern <a
* href="https://github.com/microsoft/mimalloc/">mimalloc</a> implementation
Expand Down
8 changes: 8 additions & 0 deletions docs/examples/Param.dox
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
/**
* @page example_param_page Param Examples
*
* ## Modify PostureControlParam at runtime:
*
* @include posture_param.cpp
*
*/

0 comments on commit 6b93ea5

Please sign in to comment.