Skip to content

Commit

Permalink
Update documentation, add changelog
Browse files Browse the repository at this point in the history
  • Loading branch information
Dasaav-dsv committed Apr 27, 2024
1 parent c05e134 commit e58c785
Show file tree
Hide file tree
Showing 3 changed files with 21 additions and 1 deletion.
2 changes: 1 addition & 1 deletion Doxyfile
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ PROJECT_NAME = "libER"
# could be handy for archiving the generated documentation or if some version
# control system is used.

PROJECT_NUMBER = 0.1.1.0
PROJECT_NUMBER = 0.1.2.0

# Using the PROJECT_BRIEF tag one can provide an optional one line description
# for a project that appears at the top of each page and should give viewer a
Expand Down
12 changes: 12 additions & 0 deletions docs/Changelog.dox
Original file line number Diff line number Diff line change
Expand Up @@ -8,4 +8,16 @@
* - Streamline allocation interface
* - Remove exposed get_allocator_of methods
* - Now, from::allocator<T> can deallocate anything natively
*
* ## Version 0.1.2.0:
* - Add functionality to load files from disk or the game's vfs asynchronously
* - Add 2 new examples: getting a gparam resource (after loading the file it is in),
* loading and playing back a sound from a wwise soundbank
* - Initial sound engine implementation, 2D wwise sound playback
* - Update resource types and layouts, document file/resource capsules
* - from::shared_ptr with a delay deleter
* - Fix allocator heuristic error
* - Increase documentation coverage
* - Update liber::optref pointer and reference constructors
* - Start laying out namespace DLIO and DLIOD types for native file I/O
*/
8 changes: 8 additions & 0 deletions docs/MainPage.dox
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,13 @@
* @see fd4_task.hpp
* @see taskgroups.inl
*
* - @link file.hpp File & Resources @endlink: asynchronously loading files
* and resources to be used by **ELDEN RING** from disk or from the game's virtual
* directories (.bdt archives). Files can be loaded, reloaded and unloaded on demand,
* with an std::future-like interface. Resources can be obtained from their corresponding
* resource repositories.
* @see file.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 Expand Up @@ -67,6 +74,7 @@
* - @link system.hpp DLSY@endlink - system properties
* - @link text.hpp DLTX@endlink - strings
* - @link utility.hpp DLUT@endlink - utility
* - @link fileio.hpp DLIO@endlink - file
* - @link include/fd4 FD4@endlink - internal **ELDEN RING** implementation
* details
* - @link include/memory from::* containers and memory@endlink
Expand Down

0 comments on commit e58c785

Please sign in to comment.