From 4d6b41c7a58ae7bc200b0f197737ab9c80c24e58 Mon Sep 17 00:00:00 2001 From: Davis King Date: Sat, 11 Nov 2023 18:01:10 -0500 Subject: [PATCH] Update HTML docs more --- docs/docs/imaging.xml | 17 +++++++++++++++++ docs/docs/linear_algebra.xml | 12 ++++++++++++ docs/docs/release_notes.xml | 16 +++++++--------- docs/docs/term_index.xml | 2 ++ 4 files changed, 38 insertions(+), 9 deletions(-) diff --git a/docs/docs/imaging.xml b/docs/docs/imaging.xml index 769ab85518..e716583b6c 100644 --- a/docs/docs/imaging.xml +++ b/docs/docs/imaging.xml @@ -38,6 +38,10 @@ +
  • HSV + +
  • LAB
  • @@ -70,6 +74,7 @@ rgb_alpha_pixel bgr_alpha_pixel hsi_pixel + hsv_pixel lab_pixel pixel_traits get_pixel_intensity @@ -835,6 +840,18 @@ + + + + hsv_pixel + dlib/pixel.h + dlib/pixel.h + + This is a simple struct that represents a HSV colored graphical pixel. + + + + diff --git a/docs/docs/linear_algebra.xml b/docs/docs/linear_algebra.xml index 45ee0bace0..8c9608d8ca 100644 --- a/docs/docs/linear_algebra.xml +++ b/docs/docs/linear_algebra.xml @@ -675,6 +675,7 @@ is_convex_quadrilateral find_convex_quadrilateral polygon_area + polygon @@ -1387,6 +1388,17 @@ + + + + polygon + dlib/geometry.h + dlib/geometry/polygon_abstract.h + + This class represents a polygon in a 2D coordinate system. + + + diff --git a/docs/docs/release_notes.xml b/docs/docs/release_notes.xml index 37faac445f..97cb945486 100644 --- a/docs/docs/release_notes.xml +++ b/docs/docs/release_notes.xml @@ -18,7 +18,7 @@ New Features and Improvements: - Add insert_image_chip() (PR #2781) - Unify all conversions to UTF-32 #2737 - - Adds convert_to_utf32 + - Adds convert_to_utf32() - Backports of new C++ tooling not yet available in C++14: - Added bind_front() and bind_back() (PR #2705) @@ -30,7 +30,7 @@ New Features and Improvements: - Container classes - Support noexcept dlib::type_safe_union::swap() (PR #2604) - dlib::optional (PR #2815) - - New type erasure tooling in dlib::te (PR #2666) + - New type erasure tooling in dlib/any/storage.h (PR #2666) - Update libraries in dlib/external - Update libjpeg to version 9e (PR #2619) @@ -43,24 +43,22 @@ New Features and Improvements: - circular_buffer : 10X speedup (PR #2779) - type_safe_union : visit() and apply_to_contents() performance improvements (PR #2615) - Speed up DNN execution. PRs: 2656, 2839, 2842 + - Add support for loading custom label fonts in imglab via --font (PR #2733) + - Add HSV pixel support (PR #2758) + - Add simple polygon class (PR #2750) + # TODO: davis update web docs for this - FFT tooling - stft(), istft(), stftr() and istftr() (PR #2627) - [FFT] split FFT API into different layers #2793 - Adds the dlib/fft folder and some more overloads of fft functions. Update doc links for sure. - - - if constexpr() for C++14 (PR #2654) - Adds dlib/constexpr_if.h, update doc links with this - - FFMPEG wrappers: dlib::ffmpeg::decoder and dlib::ffmpeg::demuxer (PR #2707) - - Add support for loading custom label fonts in imglab (PR #2733) - - Add simple polygon class (PR #2750) - - Add HSV pixel support (PR #2758) Non-Backwards Compatible Changes: - - Make C++14 and CMake 3.8.0 the new minimum required versions + - Dlib now requires C++14 and at least CMake version 3.8.0. Bug fixes: - Various adjustments to avoid errors on unusual platforms of system configurations. diff --git a/docs/docs/term_index.xml b/docs/docs/term_index.xml index 4103c45ff6..b50db6ea46 100644 --- a/docs/docs/term_index.xml +++ b/docs/docs/term_index.xml @@ -465,6 +465,7 @@ + @@ -1571,6 +1572,7 @@ +