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

31
doc/build.dox Normal file
View file

@ -0,0 +1,31 @@
/*! \page Build Build libragephoto
Keep sure you have CMake and a C++ compiler installed, then do the following or the equivalent necessary.
<h4 id="build">Build libragephoto</h4>
\code{.sh}
cmake -B libragephoto-build libragephoto
cmake --build libragephoto-build
\endcode
<h4 id="install">Install libragephoto</h4>
\code{.sh}
sudo cmake --install libragephoto-build
\endcode
To customise your libragephoto build, the following <a href="#flags">Optional CMake flags</a> can be used
<h4 id="flags">Optional CMake flags</h4>
\code{.sh}
-DRAGEPHOTO_CXX_STANDARD=17
-DRAGEPHOTO_BENCHMARK=ON
-DRAGEPHOTO_C_API=OFF
-DRAGEPHOTO_C_LIBRARY=ON
-DRAGEPHOTO_DEBUG=ON
-DRAGEPHOTO_DOC=ON
-DRAGEPHOTO_EXAMPLE_GTKVIEWER=ON
-DRAGEPHOTO_EXAMPLE_QTVIEWER=ON
-DRAGEPHOTO_EXTRACT=OFF
-DRAGEPHOTO_STATIC=ON
\endcode
*/