diff options
| -rw-r--r-- | doc/CMakeLists.txt | 8 | ||||
| -rw-r--r-- | doc/Doxyfile.dox | 290 | ||||
| -rw-r--r-- | doc/Doxyfile.dox.cmake.in | 2 | ||||
| -rw-r--r-- | doc/jpip_architect.png (renamed from applications/jpip/doc/jpip_architect.png) | bin | 62577 -> 62577 bytes | |||
| -rw-r--r-- | doc/jpip_protocol.png (renamed from applications/jpip/doc/jpip_protocol.png) | bin | 6376 -> 6376 bytes | |||
| -rw-r--r-- | doc/mainpage.dox.in (renamed from doc/mainpage.dox.cmake) | 0 | ||||
| -rw-r--r-- | doc/openjpip.dox.in (renamed from applications/jpip/mainpage.h) | 2 | ||||
| -rw-r--r-- | src/lib/openjp2/function_list.h | 2 | ||||
| -rw-r--r-- | thirdparty/README.txt | 9 |
9 files changed, 19 insertions, 294 deletions
diff --git a/doc/CMakeLists.txt b/doc/CMakeLists.txt index 7c86093a..f5ce1e24 100644 --- a/doc/CMakeLists.txt +++ b/doc/CMakeLists.txt @@ -12,8 +12,14 @@ if(DOXYGEN_FOUND) # Configure the html mainpage file of the doxygen documentation with variable # from CMake and move it - configure_file(${CMAKE_CURRENT_SOURCE_DIR}/mainpage.dox.cmake + configure_file(${CMAKE_CURRENT_SOURCE_DIR}/mainpage.dox.in ${CMAKE_BINARY_DIR}/doc/mainpage.dox @ONLY) + configure_file(${CMAKE_CURRENT_SOURCE_DIR}/openjpip.dox.in + ${CMAKE_BINARY_DIR}/doc/openjpip.dox @ONLY) + configure_file(${CMAKE_CURRENT_SOURCE_DIR}/jpip_architect.png + ${CMAKE_BINARY_DIR}/doc/html/jpip_architect.png COPYONLY) + configure_file(${CMAKE_CURRENT_SOURCE_DIR}/jpip_protocol.png + ${CMAKE_BINARY_DIR}/doc/html/jpip_protocol.png COPYONLY) # Generate new target to build the html documentation add_custom_target(doc ALL diff --git a/doc/Doxyfile.dox b/doc/Doxyfile.dox deleted file mode 100644 index 53209148..00000000 --- a/doc/Doxyfile.dox +++ /dev/null @@ -1,290 +0,0 @@ -# Doxyfile 1.7.3 - -#--------------------------------------------------------------------------- -# Project related configuration options -#--------------------------------------------------------------------------- -DOXYFILE_ENCODING = UTF-8 -PROJECT_NAME = OpenJPEG -PROJECT_NUMBER = -PROJECT_BRIEF = -PROJECT_LOGO = -OUTPUT_DIRECTORY = . -CREATE_SUBDIRS = NO -OUTPUT_LANGUAGE = English -BRIEF_MEMBER_DESC = YES -REPEAT_BRIEF = YES -ABBREVIATE_BRIEF = "The $name class" \ - "The $name widget" \ - "The $name file" \ - is \ - provides \ - specifies \ - contains \ - represents \ - a \ - an \ - the -ALWAYS_DETAILED_SEC = NO -INLINE_INHERITED_MEMB = NO -FULL_PATH_NAMES = NO -STRIP_FROM_PATH = C:// -STRIP_FROM_INC_PATH = -SHORT_NAMES = NO -JAVADOC_AUTOBRIEF = YES -QT_AUTOBRIEF = NO -MULTILINE_CPP_IS_BRIEF = NO -INHERIT_DOCS = YES -SEPARATE_MEMBER_PAGES = NO -TAB_SIZE = 8 -ALIASES = -OPTIMIZE_OUTPUT_FOR_C = YES -OPTIMIZE_OUTPUT_JAVA = NO -OPTIMIZE_FOR_FORTRAN = NO -OPTIMIZE_OUTPUT_VHDL = NO -EXTENSION_MAPPING = -BUILTIN_STL_SUPPORT = NO -CPP_CLI_SUPPORT = NO -SIP_SUPPORT = NO -IDL_PROPERTY_SUPPORT = YES -DISTRIBUTE_GROUP_DOC = NO -SUBGROUPING = YES -TYPEDEF_HIDES_STRUCT = NO -SYMBOL_CACHE_SIZE = 0 -#--------------------------------------------------------------------------- -# Build related configuration options -#--------------------------------------------------------------------------- -EXTRACT_ALL = YES -EXTRACT_PRIVATE = YES -EXTRACT_STATIC = YES -EXTRACT_LOCAL_CLASSES = YES -EXTRACT_LOCAL_METHODS = NO -EXTRACT_ANON_NSPACES = NO -HIDE_UNDOC_MEMBERS = NO -HIDE_UNDOC_CLASSES = NO -HIDE_FRIEND_COMPOUNDS = NO -HIDE_IN_BODY_DOCS = NO -INTERNAL_DOCS = NO -CASE_SENSE_NAMES = NO -HIDE_SCOPE_NAMES = NO -SHOW_INCLUDE_FILES = YES -FORCE_LOCAL_INCLUDES = NO -INLINE_INFO = YES -SORT_MEMBER_DOCS = YES -SORT_BRIEF_DOCS = NO -SORT_MEMBERS_CTORS_1ST = NO -SORT_GROUP_NAMES = NO -SORT_BY_SCOPE_NAME = NO -STRICT_PROTO_MATCHING = NO -GENERATE_TODOLIST = YES -GENERATE_TESTLIST = YES -GENERATE_BUGLIST = YES -GENERATE_DEPRECATEDLIST= YES -ENABLED_SECTIONS = -MAX_INITIALIZER_LINES = 30 -SHOW_USED_FILES = YES -SHOW_DIRECTORIES = NO -SHOW_FILES = YES -SHOW_NAMESPACES = YES -FILE_VERSION_FILTER = -LAYOUT_FILE = -#--------------------------------------------------------------------------- -# configuration options related to warning and progress messages -#--------------------------------------------------------------------------- -QUIET = NO -WARNINGS = YES -WARN_IF_UNDOCUMENTED = YES -WARN_IF_DOC_ERROR = YES -WARN_NO_PARAMDOC = NO -WARN_FORMAT = "$file:$line: $text" -WARN_LOGFILE = -#--------------------------------------------------------------------------- -# configuration options related to the input files -#--------------------------------------------------------------------------- -INPUT = ../libopenjpeg \ - ../libopenjpeg/jpwl -INPUT_ENCODING = UTF-8 -FILE_PATTERNS = *.h \ - *.c -RECURSIVE = NO -EXCLUDE = -EXCLUDE_SYMLINKS = NO -EXCLUDE_PATTERNS = -EXCLUDE_SYMBOLS = -EXAMPLE_PATH = -EXAMPLE_PATTERNS = * -EXAMPLE_RECURSIVE = NO -IMAGE_PATH = -INPUT_FILTER = -FILTER_PATTERNS = -FILTER_SOURCE_FILES = NO -FILTER_SOURCE_PATTERNS = -#--------------------------------------------------------------------------- -# configuration options related to source browsing -#--------------------------------------------------------------------------- -SOURCE_BROWSER = NO -INLINE_SOURCES = NO -STRIP_CODE_COMMENTS = YES -REFERENCED_BY_RELATION = YES -REFERENCES_RELATION = YES -REFERENCES_LINK_SOURCE = YES -USE_HTAGS = NO -VERBATIM_HEADERS = YES -#--------------------------------------------------------------------------- -# configuration options related to the alphabetical class index -#--------------------------------------------------------------------------- -ALPHABETICAL_INDEX = NO -COLS_IN_ALPHA_INDEX = 5 -IGNORE_PREFIX = -#--------------------------------------------------------------------------- -# configuration options related to the HTML output -#--------------------------------------------------------------------------- -GENERATE_HTML = YES -HTML_OUTPUT = ./html -HTML_FILE_EXTENSION = .html -HTML_HEADER = -HTML_FOOTER = -HTML_STYLESHEET = -HTML_COLORSTYLE_HUE = 220 -HTML_COLORSTYLE_SAT = 100 -HTML_COLORSTYLE_GAMMA = 80 -HTML_TIMESTAMP = YES -HTML_ALIGN_MEMBERS = YES -HTML_DYNAMIC_SECTIONS = NO -GENERATE_DOCSET = NO -DOCSET_FEEDNAME = "Doxygen generated docs" -DOCSET_BUNDLE_ID = org.doxygen.Project -DOCSET_PUBLISHER_ID = org.doxygen.Publisher -DOCSET_PUBLISHER_NAME = Publisher -GENERATE_HTMLHELP = NO -CHM_FILE = -HHC_LOCATION = -GENERATE_CHI = NO -CHM_INDEX_ENCODING = -BINARY_TOC = NO -TOC_EXPAND = NO -GENERATE_QHP = NO -QCH_FILE = -QHP_NAMESPACE = org.doxygen.Project -QHP_VIRTUAL_FOLDER = doc -QHP_CUST_FILTER_NAME = -QHP_CUST_FILTER_ATTRS = -QHP_SECT_FILTER_ATTRS = -QHG_LOCATION = -GENERATE_ECLIPSEHELP = NO -ECLIPSE_DOC_ID = org.doxygen.Project -DISABLE_INDEX = NO -ENUM_VALUES_PER_LINE = 4 -GENERATE_TREEVIEW = NO -USE_INLINE_TREES = NO -TREEVIEW_WIDTH = 250 -EXT_LINKS_IN_WINDOW = NO -FORMULA_FONTSIZE = 10 -FORMULA_TRANSPARENT = YES -USE_MATHJAX = NO -MATHJAX_RELPATH = http://www.mathjax.org/mathjax -SEARCHENGINE = NO -SERVER_BASED_SEARCH = NO -#--------------------------------------------------------------------------- -# configuration options related to the LaTeX output -#--------------------------------------------------------------------------- -GENERATE_LATEX = NO -LATEX_OUTPUT = latex -LATEX_CMD_NAME = latex -MAKEINDEX_CMD_NAME = makeindex -COMPACT_LATEX = NO -PAPER_TYPE = a4wide -EXTRA_PACKAGES = -LATEX_HEADER = -PDF_HYPERLINKS = NO -USE_PDFLATEX = NO -LATEX_BATCHMODE = NO -LATEX_HIDE_INDICES = NO -LATEX_SOURCE_CODE = NO -#--------------------------------------------------------------------------- -# configuration options related to the RTF output -#--------------------------------------------------------------------------- -GENERATE_RTF = NO -RTF_OUTPUT = rtf -COMPACT_RTF = NO -RTF_HYPERLINKS = NO -RTF_STYLESHEET_FILE = -RTF_EXTENSIONS_FILE = -#--------------------------------------------------------------------------- -# configuration options related to the man page output -#--------------------------------------------------------------------------- -GENERATE_MAN = NO -MAN_OUTPUT = man -MAN_EXTENSION = .3 -MAN_LINKS = NO -#--------------------------------------------------------------------------- -# configuration options related to the XML output -#--------------------------------------------------------------------------- -GENERATE_XML = NO -XML_OUTPUT = xml -XML_SCHEMA = -XML_DTD = -XML_PROGRAMLISTING = YES -#--------------------------------------------------------------------------- -# configuration options for the AutoGen Definitions output -#--------------------------------------------------------------------------- -GENERATE_AUTOGEN_DEF = NO -#--------------------------------------------------------------------------- -# configuration options related to the Perl module output -#--------------------------------------------------------------------------- -GENERATE_PERLMOD = NO -PERLMOD_LATEX = NO -PERLMOD_PRETTY = YES -PERLMOD_MAKEVAR_PREFIX = -#--------------------------------------------------------------------------- -# Configuration options related to the preprocessor -#--------------------------------------------------------------------------- -ENABLE_PREPROCESSING = YES -MACRO_EXPANSION = NO -EXPAND_ONLY_PREDEF = NO -SEARCH_INCLUDES = YES -INCLUDE_PATH = -INCLUDE_FILE_PATTERNS = -PREDEFINED = USE_JPWL \ - USE_JPSEC -EXPAND_AS_DEFINED = -SKIP_FUNCTION_MACROS = YES -#--------------------------------------------------------------------------- -# Configuration::additions related to external references -#--------------------------------------------------------------------------- -TAGFILES = -GENERATE_TAGFILE = -ALLEXTERNALS = NO -EXTERNAL_GROUPS = YES -PERL_PATH = /usr/bin/perl -#--------------------------------------------------------------------------- -# Configuration options related to the dot tool -#--------------------------------------------------------------------------- -CLASS_DIAGRAMS = YES -MSCGEN_PATH = -HIDE_UNDOC_RELATIONS = YES -HAVE_DOT = NO -DOT_NUM_THREADS = 0 -DOT_FONTNAME = Helvetica -DOT_FONTSIZE = 10 -DOT_FONTPATH = -CLASS_GRAPH = YES -COLLABORATION_GRAPH = YES -GROUP_GRAPHS = YES -UML_LOOK = NO -TEMPLATE_RELATIONS = NO -INCLUDE_GRAPH = YES -INCLUDED_BY_GRAPH = YES -CALL_GRAPH = NO -CALLER_GRAPH = NO -GRAPHICAL_HIERARCHY = YES -DIRECTORY_GRAPH = YES -DOT_IMAGE_FORMAT = png -DOT_PATH = -DOTFILE_DIRS = -MSCFILE_DIRS = -DOT_GRAPH_MAX_NODES = 50 -MAX_DOT_GRAPH_DEPTH = 1000 -DOT_TRANSPARENT = NO -DOT_MULTI_TARGETS = NO -GENERATE_LEGEND = YES -DOT_CLEANUP = YES diff --git a/doc/Doxyfile.dox.cmake.in b/doc/Doxyfile.dox.cmake.in index 1bd970e8..71d28702 100644 --- a/doc/Doxyfile.dox.cmake.in +++ b/doc/Doxyfile.dox.cmake.in @@ -100,7 +100,7 @@ WARN_LOGFILE = #--------------------------------------------------------------------------- # configuration options related to the input files #--------------------------------------------------------------------------- -INPUT = @OPENJPEG_SOURCE_DIR@/libopenjpeg \ +INPUT = @OPENJPEG_SOURCE_DIR@/src/lib \ @OPENJPEG_BINARY_DIR@/doc INPUT_ENCODING = UTF-8 FILE_PATTERNS = *.h \ diff --git a/applications/jpip/doc/jpip_architect.png b/doc/jpip_architect.png Binary files differindex 5375bf91..5375bf91 100644 --- a/applications/jpip/doc/jpip_architect.png +++ b/doc/jpip_architect.png diff --git a/applications/jpip/doc/jpip_protocol.png b/doc/jpip_protocol.png Binary files differindex bc326d45..bc326d45 100644 --- a/applications/jpip/doc/jpip_protocol.png +++ b/doc/jpip_protocol.png diff --git a/doc/mainpage.dox.cmake b/doc/mainpage.dox.in index 732f7540..732f7540 100644 --- a/doc/mainpage.dox.cmake +++ b/doc/mainpage.dox.in diff --git a/applications/jpip/mainpage.h b/doc/openjpip.dox.in index 1ac921e7..76bc5d2a 100644 --- a/applications/jpip/mainpage.h +++ b/doc/openjpip.dox.in @@ -28,7 +28,7 @@ * POSSIBILITY OF SUCH DAMAGE. */ -/*! \mainpage OpenJPIP v2.1 Documentation +/*! \page openjpippage OpenJPIP v2.1 Documentation * * \section intro Introduction * This manual documents the low-level OpenJPIP C API.\n diff --git a/src/lib/openjp2/function_list.h b/src/lib/openjp2/function_list.h index 3707eec5..f67aa5f2 100644 --- a/src/lib/openjp2/function_list.h +++ b/src/lib/openjp2/function_list.h @@ -34,7 +34,7 @@ * The functions in validation.c aims to have access to a list of procedures. */ -/** @defgroup validation validation procedure*/ +/** @defgroup VAL VAL - validation procedure*/ /*@{*/ /************************************************************************************************** diff --git a/thirdparty/README.txt b/thirdparty/README.txt new file mode 100644 index 00000000..e7a961c0 --- /dev/null +++ b/thirdparty/README.txt @@ -0,0 +1,9 @@ +This directory contains 3rd party libs (PNG, ZLIB)... + +They are convinient copy of code from people outside of the OpenJPEG community. +They are solely provided for ease of build of OpenJPEG on system where those +3rd party libs are not easily accessible (typically non-UNIX). + +The OpenJPEG does not recommend using those 3rd party libs over your system +installed libs. The OpenJPEG does not even garantee that those libraries will +work for you. |
