Skip to content

code documentation updates #1576

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
rouault merged 1 commit into from
Feb 11, 2025
Merged

code documentation updates #1576

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion src/lib/openjp2/openjpeg.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -635,6 +635,8 @@ typedef void * opj_codec_t;

/*
* Callback function prototype for read function
* @return returns The number of bytes delivered into
* \a p_buffer. -1 signals end of stream.
*/
typedef OPJ_SIZE_T(* opj_stream_read_fn)(void * p_buffer, OPJ_SIZE_T p_nb_bytes,
void * p_user_data) ;
Expand Down Expand Up @@ -1239,7 +1241,6 @@ OPJ_API void OPJ_CALLCONV opj_stream_set_user_data(opj_stream_t* p_stream,

/**
* Sets the length of the user data for the stream.
*
* @param p_stream the stream to modify
* @param data_length length of the user_data.
*/
Expand Down Expand Up @@ -1437,6 +1438,8 @@ OPJ_API OPJ_BOOL OPJ_CALLCONV opj_set_decoded_components(opj_codec_t *p_codec,
* that is to say at the highest resolution level, even if requesting the image at lower
* resolution levels.
*
* Note: If p_start_x, p_start_y, p_end_x, p_end_y are all 0, then the whole image is decoded.
*
* Generally opj_set_decode_area() should be followed by opj_decode(), and the
* codec cannot be re-used.
* In the particular case of an image made of a single tile, several sequences of
Expand Down