summaryrefslogtreecommitdiff
path: root/doc/sphinx
diff options
context:
space:
mode:
authorJiyong <jiyong.min@samsung.com>2023-12-26 17:33:03 +0900
committerJiyong <jiyong.min@samsung.com>2023-12-27 08:25:11 +0900
commita6d06c38e46e552195648836052eb909925fe5ff (patch)
tree5b34f3947c8331dc618a5166974e4d9757f8e782 /doc/sphinx
parentf3e519be675ef7922a6c1c3a682232302b55496d (diff)
parent3b773d382e34fcfc7c8995d8bd681a6ef0529b02 (diff)
downloadlibjxl-accepted/tizen_unified_riscv.tar.gz
libjxl-accepted/tizen_unified_riscv.tar.bz2
libjxl-accepted/tizen_unified_riscv.zip
Change-Id: I13b4d2c94ada4853484630800e2a8a5ae90d34c1
Diffstat (limited to 'doc/sphinx')
-rw-r--r--doc/sphinx/api.rst8
-rw-r--r--doc/sphinx/api_butteraugli.rst6
-rw-r--r--doc/sphinx/api_color.rst6
-rw-r--r--doc/sphinx/api_cpp.rst6
-rw-r--r--doc/sphinx/api_metadata.rst6
5 files changed, 23 insertions, 9 deletions
diff --git a/doc/sphinx/api.rst b/doc/sphinx/api.rst
index 56fca09..1d79041 100644
--- a/doc/sphinx/api.rst
+++ b/doc/sphinx/api.rst
@@ -1,5 +1,5 @@
-API reference
-=============
+libjxl API reference
+====================
``libjxl`` exposes a C API for encoding and decoding JPEG XL files with some
C++ header-only helpers for C++ users.
@@ -11,5 +11,7 @@ C++ header-only helpers for C++ users.
api_decoder
api_encoder
api_common
- api_butteraugli
+ api_metadata
+ api_color
api_threads
+ api_cpp
diff --git a/doc/sphinx/api_butteraugli.rst b/doc/sphinx/api_butteraugli.rst
deleted file mode 100644
index 4aae44a..0000000
--- a/doc/sphinx/api_butteraugli.rst
+++ /dev/null
@@ -1,6 +0,0 @@
-Butteraugli API - ``jxl/butteraugli.h``
-=======================================
-
-.. doxygengroup:: libjxl_butteraugli
- :members:
- :private-members:
diff --git a/doc/sphinx/api_color.rst b/doc/sphinx/api_color.rst
new file mode 100644
index 0000000..6e40d48
--- /dev/null
+++ b/doc/sphinx/api_color.rst
@@ -0,0 +1,6 @@
+Color encoding and conversion
+=============================
+
+.. doxygengroup:: libjxl_color
+ :members:
+ :private-members:
diff --git a/doc/sphinx/api_cpp.rst b/doc/sphinx/api_cpp.rst
new file mode 100644
index 0000000..cc5e985
--- /dev/null
+++ b/doc/sphinx/api_cpp.rst
@@ -0,0 +1,6 @@
+C++ helpers
+===========
+
+.. doxygengroup:: libjxl_cpp
+ :members:
+ :private-members:
diff --git a/doc/sphinx/api_metadata.rst b/doc/sphinx/api_metadata.rst
new file mode 100644
index 0000000..ddc5b03
--- /dev/null
+++ b/doc/sphinx/api_metadata.rst
@@ -0,0 +1,6 @@
+Image and frame metadata
+========================
+
+.. doxygengroup:: libjxl_metadata
+ :members:
+ :private-members: