Merge pull request #53 from bgilbert/index

jcupitt · web-flow · commit 92f731dff492 · 2023-05-27T10:08:09.000+01:00
dicom.h: note some one-based indexes
diff --git a/include/dicom/dicom.h b/include/dicom/dicom.h
@@ -2347,7 +2347,7 @@ uint32_t dcm_bot_get_num_frames(const DcmBOT *bot);
  * Get Frame offset in the Basic Offset Table.
  *
  * :param bot: Basic Offset Table
- * :param index: Zero-based index of Frame in the Pixel Data Element
+ * :param index: One-based index of Frame in the Pixel Data Element
  *
  * :return: offset from pixel_data_offset
  */
@@ -2496,7 +2496,7 @@ DcmBOT *dcm_filehandle_build_bot(DcmError **error, DcmFilehandle *filehandle,
  * :param filehandle: File
  * :param metadata: Metadata
  * :param bot: Basic Offset Table
- * :param index: Zero-based offset of the Frame in the Pixel Data Element
+ * :param index: One-based offset of the Frame in the Pixel Data Element
  *
  * :return: Frame
  */

Original file line number	Diff line number	Diff line change
`@@ -2347,7 +2347,7 @@ uint32_t dcm_bot_get_num_frames(const DcmBOT *bot);`
`2347`	`2347`	`* Get Frame offset in the Basic Offset Table.`
`2348`	`2348`	`*`
`2349`	`2349`	`* :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`
`2351`	`2351`	`*`
`2352`	`2352`	`* :return: offset from pixel_data_offset`
`2353`	`2353`	`*/`
`@@ -2496,7 +2496,7 @@ DcmBOT dcm_filehandle_build_bot(DcmError error, DcmFilehandle filehandle,`
`2496`	`2496`	`* :param filehandle: File`
`2497`	`2497`	`* :param metadata: Metadata`
`2498`	`2498`	`* :param bot: Basic Offset Table`
`2499`		`- * :param index: Zero-based offset of the Frame in the Pixel Data Element`
	`2499`	`+ * :param index: One-based offset of the Frame in the Pixel Data Element`
`2500`	`2500`	`*`
`2501`	`2501`	`* :return: Frame`
`2502`	`2502`	`*/`