Update HTML docs more

davisking · Mar 31, 2024 · 4d6b41c · 4d6b41c
1 parent 14ba557
commit 4d6b41c
Show file tree

Hide file tree

Showing 4 changed files with 38 additions and 9 deletions.
diff --git a/docs/docs/imaging.xml b/docs/docs/imaging.xml
@@ -38,6 +38,10 @@
                   <ul>The <a href="#hsi_pixel">hsi_pixel</a> is a 24bit pixel which represents a point in the Hue Saturation Intensity 
                   (HSI) color space. </ul>
                </li>
+               <li><b>HSV</b>
+                  <ul>The <a href="#hsv_pixel">hsv_pixel</a> is a 24bit pixel which represents a point in the Hue Saturation Value 
+                  (HSV) color space. </ul>
+               </li>
                <li><b>LAB</b>
                   <ul>The <a href="#lab_pixel">lab_pixel</a> is a 24bit pixel which represents a point in the CIELab color space. </ul>
                </li>
@@ -70,6 +74,7 @@
          <item>rgb_alpha_pixel</item>
          <item>bgr_alpha_pixel</item>
          <item>hsi_pixel</item>
+         <item>hsv_pixel</item>
          <item>lab_pixel</item>
          <item>pixel_traits</item>
          <item>get_pixel_intensity</item> 
@@ -835,6 +840,18 @@
 
       </component>
 
+   <!-- ************************************************************************* -->
+
+      <component>
+         <name>hsv_pixel</name>
+         <file>dlib/pixel.h</file>
+         <spec_file link="true">dlib/pixel.h</spec_file>
+         <description>
+            This is a simple struct that represents a HSV colored graphical pixel.  
+         </description>
+
+      </component>
+
    <!-- ************************************************************************* -->
 
       <component>

diff --git a/docs/docs/linear_algebra.xml b/docs/docs/linear_algebra.xml
@@ -675,6 +675,7 @@
          <item>is_convex_quadrilateral</item> 
          <item>find_convex_quadrilateral</item> 
          <item>polygon_area</item> 
+         <item>polygon</item> 
       </section>
 
 
@@ -1387,6 +1388,17 @@
          </description>
       </component>
 
+   <!-- ************************************************************************* -->
+
+      <component>
+         <name>polygon</name>
+         <file>dlib/geometry.h</file>
+         <spec_file link="true">dlib/geometry/polygon_abstract.h</spec_file>
+         <description>        
+            This class represents a polygon in a 2D coordinate system.
+         </description>
+      </component>
+
    <!-- ************************************************************************* -->
 
       <component>

diff --git 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
@@ -465,6 +465,7 @@
          <term file="linear_algebra.html" name="angle_between_lines"             include="dlib/geometry.h"/>
          <term file="linear_algebra.html" name="is_convex_quadrilateral"         include="dlib/geometry.h"/>
          <term file="linear_algebra.html" name="polygon_area"                    include="dlib/geometry.h"/>
+         <term file="linear_algebra.html" name="polygon"                         include="dlib/geometry.h"/>
          <term file="linear_algebra.html" name="find_convex_quadrilateral"       include="dlib/geometry.h"/>
          <term file="dlib/geometry/line_abstract.h.html" name="no_convex_quadrilateral"       include="dlib/geometry.h"/>
 
@@ -1571,6 +1572,7 @@
          <term file="imaging.html" name="load_webp"             include="dlib/image_io.h"/>
          <term file="imaging.html" name="pixel_traits"         include="dlib/pixel.h"/>
          <term file="imaging.html" name="rgb_pixel"            include="dlib/pixel.h"/>
+         <term file="imaging.html" name="hsv_pixel"            include="dlib/pixel.h"/>
          <term file="imaging.html" name="bgr_pixel"            include="dlib/pixel.h"/>
          <term file="imaging.html" name="cv_image"             include="dlib/opencv.h"/>
          <term file="imaging.html" name="toMat"                include="dlib/opencv.h"/>