Official repository of the OpenJPEG project
Go to file
Mickael Savinaud f16216e270 [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.
2012-08-30 16:56:31 +00:00
CMake [trunk] Backport toplevel files from 1.5 2012-03-02 09:26:15 +00:00
applications [trunk] Remove all non-ascii characters (Several compilers and development tools are confused by non-ascii characters in source code. These have been removed) thanks to Hans Johnson 2012-08-30 16:51:30 +00:00
doc [trunk] apply patch from winfried on the mailing list. For more info see: https://groups.google.com/group/openjpeg/msg/e631d586a31c6de4 2012-04-23 13:28:20 +00:00
libopenjpeg [trunk] STYLE: Clean up documentation errors 2012-08-30 16:56:31 +00:00
m4 fixed a bug in autotools files that prevented libfcgi to be correctly found in some cases (patch from V.Torri) 2011-08-15 13:22:46 +00:00
tests [trunk] realloc is misused and may leak memory (Issue#168) 2012-08-22 18:45:31 +00:00
thirdparty [trunk] use autotools convention where #ifdef BLA, should be provided by #define BLA 1. This is to cope with pseudo autotools generated tif header. 2012-03-19 13:10:46 +00:00
AUTHORS added NEWS, AUTHORS and THANKS files. Cosmetic changes in autotools files (in trunk) 2011-08-16 13:25:42 +00:00
CMakeLists.txt [trunk] Fix installation issues. Thanks to winfried for patch. 2012-05-29 13:44:27 +00:00
CTestConfig.cmake fixed CTest configuration files 2011-06-30 13:52:23 +00:00
INSTALL add note for cmake 2011-11-24 10:20:49 +00:00
LICENSE [trunk] Backport toplevel files from 1.5 2012-03-02 09:26:15 +00:00
Makefile.am [trunk] apply patch from winfried on the mailing list. For more info see: https://groups.google.com/group/openjpeg/msg/e631d586a31c6de4 2012-04-23 13:28:20 +00:00
NEWS [trunk] Backport toplevel files from 1.5 2012-03-02 09:26:15 +00:00
README [trunk] Backport toplevel files from 1.5 2012-03-02 09:26:15 +00:00
THANKS INSTALL and THANKS files update 2011-08-22 09:59:03 +00:00
bootstrap.sh 2010-10-13 15:16:48 +00:00
configure.ac [trunk] apply patch from winfried on the mailing list. For more info see: https://groups.google.com/group/openjpeg/msg/e631d586a31c6de4 2012-04-23 13:28:20 +00:00
libopenjpeg-jpwl.pc.in [trunk] add libopenjpeg-jpwl.pc.in. fix output when --disable-shared or --disable-static is passed to configure. Minor clean up of configure.ac. 2011-10-10 06:51:08 +00:00
libopenjpeg1.pc.cmake [trunk] Backport toplevel files from 1.5 2012-03-02 09:26:15 +00:00
libopenjpeg1.pc.in [trunk] Backport toplevel files from 1.5 2012-03-02 09:26:15 +00:00
opj_config.h.cmake.in [trunk] apply patch from winfried on the mailing list. For more info see: https://groups.google.com/group/openjpeg/msg/e631d586a31c6de4 2012-04-23 13:28:20 +00:00

README

OPENJPEG LIBRARY and APPLICATIONS
----------------------------------

Details on folders hierarchy:

* libopenjpeg: contains the sources of the openjpeg library
    * jpwl: contains the additional sources if you want to build a JPWL-flavoured library.
* applications: contains all applications that use the openjpeg library
    * common: common files to all applications
    * codec: a basic codec
    * mj2: motion jpeg 2000 executables
    * JavaOpenJPEG: java jni to use openjpeg in a java program
    * jpip: complete client-server architecture for remote browsing of jpeg 2000 images. See corresponding README for more details.
    * OPJViewer: gui for displaying j2k files (based on wxWidget)
* thirdparty: thirdparty libraries used by some applications. These libraries will be built only if there are not found on the system. Note that libopenjpeg itself does not have any dependency.
* doc: doxygen documentation setup file and man pages
* tests: configuration files and utilities for the openjpeg test suite. All test images are located in 'http://openjpeg.googlecode.com/svn/data' folder.
* CMake: cmake related files
* m4: autotools related files

see LICENSE for license and copyright information.
see INSTALL for installation procedures.
see NEWS for user visible changes in successive releases.
see CHANGES for per-revision changes.