From 983503eddf0e3e229869d5b2ab2d1eeba7f82502 Mon Sep 17 00:00:00 2001 From: DRC Date: Sun, 10 Aug 2014 16:39:32 +0000 Subject: [PATCH] Fix a display issue in the documentation for tjDecompress2() (doxygen treats a star at the beginning of the line as a list bullet); make the documentation more readable by displaying fixed-width text (which is used to refer to variables and functions) in a different color. git-svn-id: svn+ssh://svn.code.sf.net/p/libjpeg-turbo/code/branches/1.3.x@1338 632fc199-4ca6-4c93-a231-07263d6284db --- doc/html/annotated.html | 1 + doc/html/classes.html | 1 + doc/html/doxygen-extra.css | 3 +++ doc/html/functions.html | 1 + doc/html/functions_vars.html | 1 + doc/html/group___turbo_j_p_e_g.html | 14 ++++++-------- doc/html/index.html | 1 + doc/html/modules.html | 1 + doc/html/structtjregion.html | 1 + doc/html/structtjscalingfactor.html | 1 + doc/html/structtjtransform.html | 1 + doxygen-extra.css | 3 +++ doxygen.config | 1 + turbojpeg.h | 4 ++-- 14 files changed, 24 insertions(+), 10 deletions(-) create mode 100644 doc/html/doxygen-extra.css create mode 100644 doxygen-extra.css diff --git a/doc/html/annotated.html b/doc/html/annotated.html index 1e3fbd0..7ceaf3e 100644 --- a/doc/html/annotated.html +++ b/doc/html/annotated.html @@ -14,6 +14,7 @@ $(document).ready(function() { searchBox.OnSelectItem(0); }); +
diff --git a/doc/html/classes.html b/doc/html/classes.html index 4722b14..613ca2b 100644 --- a/doc/html/classes.html +++ b/doc/html/classes.html @@ -14,6 +14,7 @@ $(document).ready(function() { searchBox.OnSelectItem(0); }); +
diff --git a/doc/html/doxygen-extra.css b/doc/html/doxygen-extra.css new file mode 100644 index 0000000..5abbcc2 --- /dev/null +++ b/doc/html/doxygen-extra.css @@ -0,0 +1,3 @@ +code { + color: #4665A2; +} diff --git a/doc/html/functions.html b/doc/html/functions.html index 7af0d8e..276a55c 100644 --- a/doc/html/functions.html +++ b/doc/html/functions.html @@ -14,6 +14,7 @@ $(document).ready(function() { searchBox.OnSelectItem(0); }); +
diff --git a/doc/html/functions_vars.html b/doc/html/functions_vars.html index e6a6f72..c5140f6 100644 --- a/doc/html/functions_vars.html +++ b/doc/html/functions_vars.html @@ -14,6 +14,7 @@ $(document).ready(function() { searchBox.OnSelectItem(0); }); +
diff --git a/doc/html/group___turbo_j_p_e_g.html b/doc/html/group___turbo_j_p_e_g.html index b0ab027..b095ba3 100644 --- a/doc/html/group___turbo_j_p_e_g.html +++ b/doc/html/group___turbo_j_p_e_g.html @@ -14,6 +14,7 @@ $(document).ready(function() { searchBox.OnSelectItem(0); }); +
@@ -1049,17 +1050,14 @@ If you choose option 1, *jpegSize should be set to the size of your jpegSizesize of the JPEG image (in bytes) dstBufpointer to an image buffer that will receive the decompressed image. This buffer should normally be pitch * scaledHeight bytes in size, where scaledHeight can be determined by calling TJSCALED() with the JPEG image height and one of the scaling factors returned by tjGetScalingFactors(). The dstBuf pointer may also be used to decompress into a specific region of a larger buffer. widthdesired width (in pixels) of the destination image. If this is different than the width of the JPEG image being decompressed, then TurboJPEG will use scaling in the JPEG decompressor to generate the largest possible image that will fit within the desired width. If width is set to 0, then only the height will be considered when determining the scaled image size. - pitchbytes per line of the destination image. Normally, this is scaledWidth * tjPixelSize[pixelFormat] if the decompressed image is unpadded, else TJPAD(scaledWidth * tjPixelSize[pixelFormat]) if each line of the decompressed image is padded to the nearest 32-bit boundary, as is the case for Windows bitmaps. (NOTE: scaledWidth can be determined by calling TJSCALED() with the JPEG image width and one of the scaling factors returned by tjGetScalingFactors().) You can also be clever and use the pitch parameter to skip lines, etc. Setting this parameter to 0 is the equivalent of setting it to scaledWidth - - heightdesired height (in pixels) of the destination image. If this is different than the height of the JPEG image being decompressed, then TurboJPEG will use scaling in the JPEG decompressor to generate the largest possible image that will fit within the desired height. If height is set to 0, then only the width will be considered when determining the scaled image size. - pixelFormatpixel format of the destination image (see Pixel formats.) - flagsthe bitwise OR of one or more of the flags. + pitchbytes per line of the destination image. Normally, this is scaledWidth * tjPixelSize[pixelFormat] if the decompressed image is unpadded, else TJPAD(scaledWidth * tjPixelSize[pixelFormat]) if each line of the decompressed image is padded to the nearest 32-bit boundary, as is the case for Windows bitmaps. (NOTE: scaledWidth can be determined by calling TJSCALED() with the JPEG image width and one of the scaling factors returned by tjGetScalingFactors().) You can also be clever and use the pitch parameter to skip lines, etc. Setting this parameter to 0 is the equivalent of setting it to scaledWidth * tjPixelSize[pixelFormat]. + heightdesired height (in pixels) of the destination image. If this is different than the height of the JPEG image being decompressed, then TurboJPEG will use scaling in the JPEG decompressor to generate the largest possible image that will fit within the desired height. If height is set to 0, then only the width will be considered when determining the scaled image size. + pixelFormatpixel format of the destination image (see Pixel formats.) + flagsthe bitwise OR of one or more of the flags. -
Returns
0 if successful, or -1 if an error occurred (see tjGetErrorStr().)
+
Returns
0 if successful, or -1 if an error occurred (see tjGetErrorStr().)
diff --git a/doc/html/index.html b/doc/html/index.html index 72daeb8..45a5136 100644 --- a/doc/html/index.html +++ b/doc/html/index.html @@ -14,6 +14,7 @@ $(document).ready(function() { searchBox.OnSelectItem(0); }); +
diff --git a/doc/html/modules.html b/doc/html/modules.html index 25b7ec6..2691422 100644 --- a/doc/html/modules.html +++ b/doc/html/modules.html @@ -14,6 +14,7 @@ $(document).ready(function() { searchBox.OnSelectItem(0); }); +
diff --git a/doc/html/structtjregion.html b/doc/html/structtjregion.html index 9ecd917..33ee944 100644 --- a/doc/html/structtjregion.html +++ b/doc/html/structtjregion.html @@ -14,6 +14,7 @@ $(document).ready(function() { searchBox.OnSelectItem(0); }); +
diff --git a/doc/html/structtjscalingfactor.html b/doc/html/structtjscalingfactor.html index 33c7366..749b88e 100644 --- a/doc/html/structtjscalingfactor.html +++ b/doc/html/structtjscalingfactor.html @@ -14,6 +14,7 @@ $(document).ready(function() { searchBox.OnSelectItem(0); }); +
diff --git a/doc/html/structtjtransform.html b/doc/html/structtjtransform.html index f47ca59..87a5409 100644 --- a/doc/html/structtjtransform.html +++ b/doc/html/structtjtransform.html @@ -14,6 +14,7 @@ $(document).ready(function() { searchBox.OnSelectItem(0); }); +
diff --git a/doxygen-extra.css b/doxygen-extra.css new file mode 100644 index 0000000..5abbcc2 --- /dev/null +++ b/doxygen-extra.css @@ -0,0 +1,3 @@ +code { + color: #4665A2; +} diff --git a/doxygen.config b/doxygen.config index b881d82..f9e4d44 100644 --- a/doxygen.config +++ b/doxygen.config @@ -13,3 +13,4 @@ JAVADOC_AUTOBRIEF = YES MAX_INITIALIZER_LINES = 0 ALWAYS_DETAILED_SEC = YES HTML_TIMESTAMP = NO +HTML_EXTRA_STYLESHEET = doxygen-extra.css diff --git a/turbojpeg.h b/turbojpeg.h index cb9ba5f..0a60187 100644 --- a/turbojpeg.h +++ b/turbojpeg.h @@ -722,8 +722,8 @@ DLLEXPORT tjscalingfactor* DLLCALL tjGetScalingFactors(int *numscalingfactors); * calling #TJSCALED() with the JPEG image width and one of the scaling * factors returned by #tjGetScalingFactors().) You can also be clever * and use the pitch parameter to skip lines, etc. Setting this - * parameter to 0 is the equivalent of setting it to scaledWidth - * * #tjPixelSize[pixelFormat]. + * parameter to 0 is the equivalent of setting it to scaledWidth * + * #tjPixelSize[pixelFormat]. * @param height desired height (in pixels) of the destination image. If this * is different than the height of the JPEG image being decompressed, * then TurboJPEG will use scaling in the JPEG decompressor to generate -- 2.40.0