Skip to content

Commit a8998c9

Browse files
committed
add missing docs for get_sector_count_unchecked
1 parent 756af23 commit a8998c9

File tree

1 file changed

+13
-0
lines changed

1 file changed

+13
-0
lines changed

libcommon/include/vcc/media/disk_image.h

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -297,6 +297,19 @@ namespace vcc::media
297297

298298
protected:
299299

300+
/// @brief Retrieve the number of sectors available on a specific head and track.
301+
///
302+
/// Retrieves the number of sectors available on a specific head and track of the disk
303+
/// image without validating the head and track parameters are valid.
304+
///
305+
/// @param disk_head The head the sector is stored on. This value must be a valid
306+
/// head in the disk image. If this value is not valid the behavior of the function
307+
/// is undefined.
308+
/// @param disk_track The track the sector is stored in. This value must be a valid
309+
/// head in the disk image. If this value is not valid the behavior of the function
310+
/// is undefined.
311+
///
312+
/// @return The total number of sectors or 0 (zero) if the track has no sectors.
300313
[[nodiscard]] virtual size_type get_sector_count_unchecked(
301314
size_type disk_head,
302315
size_type disk_track) const noexcept = 0;

0 commit comments

Comments
 (0)