libragephoto: improve documentation

This commit is contained in:
Syping 2024-04-09 05:21:36 +02:00
parent 0fa69667d0
commit bc9065e8dc
9 changed files with 234 additions and 109 deletions

25
doc/index.dox Normal file
View file

@ -0,0 +1,25 @@
/*! \mainpage
<h4>Open Source RAGE Photo Parser for GTA V and RDR 2</h4>
- Read/Write RAGE Photos error free and correct
- Support for metadata stored in RAGE Photos
- Export RAGE Photos to jpeg with ragephoto-extract
- High Efficient and Simple C/C++ API
<b>Getting started</b>
\subpage Build "Build libragephoto"
\subpage Usage "Using libragephoto"
<b>Reference</b>
\ref RagePhotoInstance "RagePhoto C API"
\ref ragephoto::photo "RagePhoto C++ API"
RagePhotoData (Data Object Struct)
RagePhotoFormatParser (Custom Format Parser Struct)
<b>Project Pages</b>
https://git.syping.de/Syping/libragephoto
https://gitlab.com/Syping/libragephoto
https://github.com/Syping/libragephoto
*/