Skip to content

Commit 00ecfa7

Browse files
committed
dicom.h: note some one-based indexes
A couple functions are documented to take zero-based index parameters but actually take one-based indexes. Update docs.
1 parent 7f4cbbc commit 00ecfa7

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

include/dicom/dicom.h

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2347,7 +2347,7 @@ uint32_t dcm_bot_get_num_frames(const DcmBOT *bot);
23472347
* Get Frame offset in the Basic Offset Table.
23482348
*
23492349
* :param bot: Basic Offset Table
2350-
* :param index: Zero-based index of Frame in the Pixel Data Element
2350+
* :param index: One-based index of Frame in the Pixel Data Element
23512351
*
23522352
* :return: offset from pixel_data_offset
23532353
*/
@@ -2495,7 +2495,7 @@ DcmBOT *dcm_filehandle_build_bot(DcmError **error, DcmFilehandle *filehandle,
24952495
* :param filehandle: File
24962496
* :param metadata: Metadata
24972497
* :param bot: Basic Offset Table
2498-
* :param index: Zero-based offset of the Frame in the Pixel Data Element
2498+
* :param index: One-based offset of the Frame in the Pixel Data Element
24992499
*
25002500
* :return: Frame
25012501
*/

0 commit comments

Comments
 (0)