diff options
| author | Mickael Savinaud <savmickael@users.noreply.github.com> | 2012-08-30 16:56:31 +0000 |
|---|---|---|
| committer | Mickael Savinaud <savmickael@users.noreply.github.com> | 2012-08-30 16:56:31 +0000 |
| commit | f16216e2708c3b480f726d64b589f092bbc48b02 (patch) | |
| tree | 081e94d3fc26ace9e31fdaf30f9b45f694aa08fd /libopenjpeg/t2.c | |
| parent | de9e1a069350f472a11ff3b33048bc344ff2de3a (diff) | |
[trunk] STYLE: Clean up documentation errors
Functions should only have formal documentation in one place, and preferably in the declaration (i.e. repeated documentaiton should not be at both the declaration and the definition, because it causes too much maintenance to keep them syncronized). In cases where the definition is also the declaration (as is often the case for static functions in the .c files) the documentation was preserved at the first use of the function signature.
Functions that are formally documented should contain documentation for each function argument.
The clang 3.1 compiler issues documentation warnings when the documentation block with @params preceeding a declaration does not match the argument list. This patch set follows a convention used elsewere in openjpeg to add a placeholder FIXME DOC description where one was previously missing.
Thanks to Hans Johnson.
Diffstat (limited to 'libopenjpeg/t2.c')
| -rw-r--r-- | libopenjpeg/t2.c | 21 |
1 files changed, 12 insertions, 9 deletions
diff --git a/libopenjpeg/t2.c b/libopenjpeg/t2.c index 37d64b1a..644fbce9 100644 --- a/libopenjpeg/t2.c +++ b/libopenjpeg/t2.c @@ -61,13 +61,14 @@ static int t2_encode_packet(opj_tcd_tile_t *tile, opj_tcp_t *tcp, opj_pi_iterato /** Encode a packet of a tile to a destination buffer +@param tileno Number of the tile encoded @param tile Tile for which to write the packets @param tcp Tile coding parameters @param pi Packet identity @param dest Destination buffer +@param p_data_written FIXME DOC @param len Length of the destination buffer @param cstr_info Codestream information structure -@param tileno Number of the tile encoded @return */ static opj_bool t2_encode_packet_v2( @@ -109,19 +110,21 @@ Decode a packet of a tile from a source buffer @param tcp Tile coding parameters @param pi Packet identity @param src Source buffer +@param data_read FIXME DOC +@param max_length FIXME DOC @param pack_info Packet information -@return +@return FIXME DOC */ static opj_bool t2_decode_packet_v2( - opj_t2_v2_t* t2, - opj_tcd_tile_v2_t *tile, + opj_t2_v2_t* t2, + opj_tcd_tile_v2_t *tile, opj_tcp_v2_t *tcp, - opj_pi_iterator_t *pi, - OPJ_BYTE *src, - OPJ_UINT32 * data_read, - OPJ_UINT32 max_length, - opj_packet_info_t *pack_info); + opj_pi_iterator_t *pi, + OPJ_BYTE *src, + OPJ_UINT32 * data_read, + OPJ_UINT32 max_length, + opj_packet_info_t *pack_info); static opj_bool t2_skip_packet( opj_t2_v2_t* p_t2, |