Skip to content

Commit 4d6b41c

Browse files
committed
Update HTML docs more
1 parent 14ba557 commit 4d6b41c

File tree

4 files changed

+38
-9
lines changed

4 files changed

+38
-9
lines changed

docs/docs/imaging.xml

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,10 @@
3838
<ul>The <a href="#hsi_pixel">hsi_pixel</a> is a 24bit pixel which represents a point in the Hue Saturation Intensity
3939
(HSI) color space. </ul>
4040
</li>
41+
<li><b>HSV</b>
42+
<ul>The <a href="#hsv_pixel">hsv_pixel</a> is a 24bit pixel which represents a point in the Hue Saturation Value
43+
(HSV) color space. </ul>
44+
</li>
4145
<li><b>LAB</b>
4246
<ul>The <a href="#lab_pixel">lab_pixel</a> is a 24bit pixel which represents a point in the CIELab color space. </ul>
4347
</li>
@@ -70,6 +74,7 @@
7074
<item>rgb_alpha_pixel</item>
7175
<item>bgr_alpha_pixel</item>
7276
<item>hsi_pixel</item>
77+
<item>hsv_pixel</item>
7378
<item>lab_pixel</item>
7479
<item>pixel_traits</item>
7580
<item>get_pixel_intensity</item>
@@ -835,6 +840,18 @@
835840

836841
</component>
837842

843+
<!-- ************************************************************************* -->
844+
845+
<component>
846+
<name>hsv_pixel</name>
847+
<file>dlib/pixel.h</file>
848+
<spec_file link="true">dlib/pixel.h</spec_file>
849+
<description>
850+
This is a simple struct that represents a HSV colored graphical pixel.
851+
</description>
852+
853+
</component>
854+
838855
<!-- ************************************************************************* -->
839856

840857
<component>

docs/docs/linear_algebra.xml

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -675,6 +675,7 @@
675675
<item>is_convex_quadrilateral</item>
676676
<item>find_convex_quadrilateral</item>
677677
<item>polygon_area</item>
678+
<item>polygon</item>
678679
</section>
679680

680681

@@ -1387,6 +1388,17 @@
13871388
</description>
13881389
</component>
13891390

1391+
<!-- ************************************************************************* -->
1392+
1393+
<component>
1394+
<name>polygon</name>
1395+
<file>dlib/geometry.h</file>
1396+
<spec_file link="true">dlib/geometry/polygon_abstract.h</spec_file>
1397+
<description>
1398+
This class represents a polygon in a 2D coordinate system.
1399+
</description>
1400+
</component>
1401+
13901402
<!-- ************************************************************************* -->
13911403

13921404
<component>

docs/docs/release_notes.xml

Lines changed: 7 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ New Features and Improvements:
1818
- Add insert_image_chip() (PR #2781)
1919

2020
- Unify all conversions to UTF-32 #2737
21-
- Adds convert_to_utf32
21+
- Adds convert_to_utf32()
2222

2323
- Backports of new C++ tooling not yet available in C++14:
2424
- Added bind_front() and bind_back() (PR #2705)
@@ -30,7 +30,7 @@ New Features and Improvements:
3030
- Container classes
3131
- Support noexcept dlib::type_safe_union::swap() (PR #2604)
3232
- dlib::optional (PR #2815)
33-
- New type erasure tooling in dlib::te (PR #2666)
33+
- New type erasure tooling in dlib/any/storage.h (PR #2666)
3434

3535
- Update libraries in dlib/external
3636
- Update libjpeg to version 9e (PR #2619)
@@ -43,24 +43,22 @@ New Features and Improvements:
4343
- circular_buffer : 10X speedup (PR #2779)
4444
- type_safe_union : visit() and apply_to_contents() performance improvements (PR #2615)
4545
- Speed up DNN execution. PRs: 2656, 2839, 2842
46+
- Add support for loading custom label fonts in imglab via --font (PR #2733)
47+
- Add HSV pixel support (PR #2758)
48+
- Add simple polygon class (PR #2750)
4649

4750

51+
# TODO: davis update web docs for this
4852
- FFT tooling
4953
- stft(), istft(), stftr() and istftr() (PR #2627)
5054
- [FFT] split FFT API into different layers #2793
5155
- Adds the dlib/fft folder and some more overloads of fft functions. Update doc links for sure.
52-
53-
5456
- if constexpr() for C++14 (PR #2654)
5557
- Adds dlib/constexpr_if.h, update doc links with this
56-
5758
- FFMPEG wrappers: dlib::ffmpeg::decoder and dlib::ffmpeg::demuxer (PR #2707)
58-
- Add support for loading custom label fonts in imglab (PR #2733)
59-
- Add simple polygon class (PR #2750)
60-
- Add HSV pixel support (PR #2758)
6159

6260
Non-Backwards Compatible Changes:
63-
- Make C++14 and CMake 3.8.0 the new minimum required versions
61+
- Dlib now requires C++14 and at least CMake version 3.8.0.
6462

6563
Bug fixes:
6664
- Various adjustments to avoid errors on unusual platforms of system configurations.

docs/docs/term_index.xml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -465,6 +465,7 @@
465465
<term file="linear_algebra.html" name="angle_between_lines" include="dlib/geometry.h"/>
466466
<term file="linear_algebra.html" name="is_convex_quadrilateral" include="dlib/geometry.h"/>
467467
<term file="linear_algebra.html" name="polygon_area" include="dlib/geometry.h"/>
468+
<term file="linear_algebra.html" name="polygon" include="dlib/geometry.h"/>
468469
<term file="linear_algebra.html" name="find_convex_quadrilateral" include="dlib/geometry.h"/>
469470
<term file="dlib/geometry/line_abstract.h.html" name="no_convex_quadrilateral" include="dlib/geometry.h"/>
470471

@@ -1571,6 +1572,7 @@
15711572
<term file="imaging.html" name="load_webp" include="dlib/image_io.h"/>
15721573
<term file="imaging.html" name="pixel_traits" include="dlib/pixel.h"/>
15731574
<term file="imaging.html" name="rgb_pixel" include="dlib/pixel.h"/>
1575+
<term file="imaging.html" name="hsv_pixel" include="dlib/pixel.h"/>
15741576
<term file="imaging.html" name="bgr_pixel" include="dlib/pixel.h"/>
15751577
<term file="imaging.html" name="cv_image" include="dlib/opencv.h"/>
15761578
<term file="imaging.html" name="toMat" include="dlib/opencv.h"/>

0 commit comments

Comments
 (0)