]> granicus.if.org Git - openjpeg/commit
[trunk] STYLE: Clean up documentation errors
authorMickael Savinaud <savmickael@users.noreply.github.com>
Thu, 30 Aug 2012 16:56:31 +0000 (16:56 +0000)
committerMickael Savinaud <savmickael@users.noreply.github.com>
Thu, 30 Aug 2012 16:56:31 +0000 (16:56 +0000)
commitf16216e2708c3b480f726d64b589f092bbc48b02
tree081e94d3fc26ace9e31fdaf30f9b45f694aa08fd
parentde9e1a069350f472a11ff3b33048bc344ff2de3a
[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.
15 files changed:
libopenjpeg/cio.c
libopenjpeg/j2k.c
libopenjpeg/j2k.h
libopenjpeg/jp2.c
libopenjpeg/jp2.h
libopenjpeg/jpwl/jpwl.c
libopenjpeg/openjpeg.c
libopenjpeg/openjpeg.h
libopenjpeg/pi.c
libopenjpeg/pi.h
libopenjpeg/t1.h
libopenjpeg/t2.c
libopenjpeg/t2.h
libopenjpeg/tcd.c
libopenjpeg/tcd.h