From c97f2848cdc037ed11d295a2e8f2d4005542255f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Adri=C3=A0=20Arrufat?= Date: Thu, 29 Feb 2024 13:35:16 +0900 Subject: [PATCH] documentation formatting --- dlib/image_loader/jxl_loader_abstract.h | 6 ++++-- dlib/image_saver/save_jxl_abstract.h | 12 ++++++------ 2 files changed, 10 insertions(+), 8 deletions(-) diff --git a/dlib/image_loader/jxl_loader_abstract.h b/dlib/image_loader/jxl_loader_abstract.h index 529ecdcbb0..5edf836f14 100644 --- a/dlib/image_loader/jxl_loader_abstract.h +++ b/dlib/image_loader/jxl_loader_abstract.h @@ -68,7 +68,8 @@ namespace dlib ); /*! ensures - - loads the JPEG XL from memory imgbuffer of size buffersize into this object + - loads the JPEG XL from memory imgbuffer of size buffersize into + this object throws - image_load_error This exception is thrown if there is some error that prevents @@ -104,7 +105,8 @@ namespace dlib ) const; /*! ensures - - if (this object contains a grayscale image without an alpha channel) then + - if (this object contains a grayscale image without an alpha channel) + then - returns true - else - returns false diff --git a/dlib/image_saver/save_jxl_abstract.h b/dlib/image_saver/save_jxl_abstract.h index 66ec35f490..c38aae1272 100644 --- a/dlib/image_saver/save_jxl_abstract.h +++ b/dlib/image_saver/save_jxl_abstract.h @@ -32,14 +32,14 @@ namespace dlib - image[image.nr()-1][image.nc()-1] will be in the lower right corner of the image. - This routine can save images containing any type of pixel. However, - save_jxl() can only natively store rgb_pixel, rgb_alpha_pixel and unsigned char - pixel types. All other pixel types will be converted into one of these types as - appropriate before being saved to disk. + save_jxl() can only natively store rgb_pixel, rgb_alpha_pixel and unsigned + char pixel types. All other pixel types will be converted into one of + these types as appropriate before being saved to disk. - The quality value determines how lossy the compression is. Larger quality values result in larger output images but the images will look better. - Although it can range from 0 to 100, the recommended range is between 68 and 96. - A value of 90 means visually lossless, while a value of 100 means mathematically - lossless. + Although it can range from 0 to 100, the recommended range is between + 68 and 96. A value of 90 means visually lossless, while a value of 100 + means mathematically lossless. throws - image_save_error This exception is thrown if there is an error that prevents us from saving