summaryrefslogtreecommitdiff
path: root/media/libjxl/src/doc/api.txt
diff options
context:
space:
mode:
Diffstat (limited to 'media/libjxl/src/doc/api.txt')
-rw-r--r--media/libjxl/src/doc/api.txt29
1 files changed, 29 insertions, 0 deletions
diff --git a/media/libjxl/src/doc/api.txt b/media/libjxl/src/doc/api.txt
new file mode 100644
index 0000000000..ed3f939acb
--- /dev/null
+++ b/media/libjxl/src/doc/api.txt
@@ -0,0 +1,29 @@
+/* This document is meant for Doxygen use only. If you are looking for the API
+ * documentation generate it with `./ci.sh release` and look under the
+ * build/html directory.
+ *
+ * This file documents all the groups and defines the order in which they appear
+ * in Doxygen. Define the @defgroup commands here and use @addtogroup anywhere
+ * else.
+ */
+
+/**
+@defgroup libjxl JPEG XL library (libjxl)
+@brief The main JPEG XL decoder / encoder library.
+
+@addtogroup libjxl
+@{
+
+@defgroup libjxl_decoder JPEG XL Decoder
+
+@defgroup libjxl_encoder JPEG XL Encoder
+
+@defgroup libjxl_common JPEG XL common definitions
+
+@defgroup libjxl_butteraugli Butteraugli metric
+
+@}
+
+@defgroup libjxl_threads JPEG XL Multi-thread library (libjxl_threads)
+@brief Additional multi-threaded implementations for the parallel runner.
+*/