doc/Doxyfile.dox

   1 # Doxyfile 1.4.2
   2
   3 #---------------------------------------------------------------------------
   4 # Project related configuration options
   5 #---------------------------------------------------------------------------
   6 PROJECT_NAME           = OpenJPEG
   7 PROJECT_NUMBER         =
   8 OUTPUT_DIRECTORY       = ../
   9 CREATE_SUBDIRS         = NO
  10 OUTPUT_LANGUAGE        = English
  11 USE_WINDOWS_ENCODING   = YES
  12 BRIEF_MEMBER_DESC      = YES
  13 REPEAT_BRIEF           = YES
  14 ABBREVIATE_BRIEF       = "The $name class" \
  15                          "The $name widget" \
  16                          "The $name file" \
  17                          is \
  18                          provides \
  19                          specifies \
  20                          contains \
  21                          represents \
  22                          a \
  23                          an \
  24                          the
  25 ALWAYS_DETAILED_SEC    = NO
  26 INLINE_INHERITED_MEMB  = NO
  27 FULL_PATH_NAMES        = NO
  28 STRIP_FROM_PATH        = C://
  29 STRIP_FROM_INC_PATH    =
  30 SHORT_NAMES            = NO
  31 JAVADOC_AUTOBRIEF      = YES
  32 MULTILINE_CPP_IS_BRIEF = NO
  33 DETAILS_AT_TOP         = YES
  34 INHERIT_DOCS           = YES
  35 DISTRIBUTE_GROUP_DOC   = NO
  36 SEPARATE_MEMBER_PAGES  = NO
  37 TAB_SIZE               = 8
  38 ALIASES                =
  39 OPTIMIZE_OUTPUT_FOR_C  = YES
  40 OPTIMIZE_OUTPUT_JAVA   = NO
  41 SUBGROUPING            = YES
  42 #---------------------------------------------------------------------------
  43 # Build related configuration options
  44 #---------------------------------------------------------------------------
  45 EXTRACT_ALL            = YES
  46 EXTRACT_PRIVATE        = YES
  47 EXTRACT_STATIC         = YES
  48 EXTRACT_LOCAL_CLASSES  = YES
  49 EXTRACT_LOCAL_METHODS  = NO
  50 HIDE_UNDOC_MEMBERS     = NO
  51 HIDE_UNDOC_CLASSES     = NO
  52 HIDE_FRIEND_COMPOUNDS  = NO
  53 HIDE_IN_BODY_DOCS      = NO
  54 INTERNAL_DOCS          = NO
  55 CASE_SENSE_NAMES       = NO
  56 HIDE_SCOPE_NAMES       = NO
  57 SHOW_INCLUDE_FILES     = YES
  58 INLINE_INFO            = YES
  59 SORT_MEMBER_DOCS       = YES
  60 SORT_BRIEF_DOCS        = NO
  61 SORT_BY_SCOPE_NAME     = NO
  62 GENERATE_TODOLIST      = YES
  63 GENERATE_TESTLIST      = YES
  64 GENERATE_BUGLIST       = YES
  65 GENERATE_DEPRECATEDLIST= YES
  66 ENABLED_SECTIONS       =
  67 MAX_INITIALIZER_LINES  = 30
  68 SHOW_USED_FILES        = YES
  69 SHOW_DIRECTORIES       = NO
  70 FILE_VERSION_FILTER    =
  71 #---------------------------------------------------------------------------
  72 # configuration options related to warning and progress messages
  73 #---------------------------------------------------------------------------
  74 QUIET                  = NO
  75 WARNINGS               = YES
  76 WARN_IF_UNDOCUMENTED   = YES
  77 WARN_IF_DOC_ERROR      = YES
  78 WARN_NO_PARAMDOC       = NO
  79 WARN_FORMAT            = "$file:$line: $text"
  80 WARN_LOGFILE           =
  81 #---------------------------------------------------------------------------
  82 # configuration options related to the input files
  83 #---------------------------------------------------------------------------
  84 INPUT                  = ../libopenjpeg
  85 FILE_PATTERNS          = *.h \
  86                          *.c
  87 RECURSIVE              = NO
  88 EXCLUDE                =
  89 EXCLUDE_SYMLINKS       = NO
  90 EXCLUDE_PATTERNS       =
  91 EXAMPLE_PATH           =
  92 EXAMPLE_PATTERNS       = *
  93 EXAMPLE_RECURSIVE      = NO
  94 IMAGE_PATH             =
  95 INPUT_FILTER           =
  96 FILTER_PATTERNS        =
  97 FILTER_SOURCE_FILES    = NO
  98 #---------------------------------------------------------------------------
  99 # configuration options related to source browsing
 100 #---------------------------------------------------------------------------
 101 SOURCE_BROWSER         = NO
 102 INLINE_SOURCES         = NO
 103 STRIP_CODE_COMMENTS    = YES
 104 REFERENCED_BY_RELATION = YES
 105 REFERENCES_RELATION    = YES
 106 VERBATIM_HEADERS       = YES
 107 #---------------------------------------------------------------------------
 108 # configuration options related to the alphabetical class index
 109 #---------------------------------------------------------------------------
 110 ALPHABETICAL_INDEX     = NO
 111 COLS_IN_ALPHA_INDEX    = 5
 112 IGNORE_PREFIX          =
 113 #---------------------------------------------------------------------------
 114 # configuration options related to the HTML output
 115 #---------------------------------------------------------------------------
 116 GENERATE_HTML          = YES
 117 HTML_OUTPUT            = ./html
 118 HTML_FILE_EXTENSION    = .html
 119 HTML_HEADER            =
 120 HTML_FOOTER            =
 121 HTML_STYLESHEET        =
 122 HTML_ALIGN_MEMBERS     = YES
 123 GENERATE_HTMLHELP      = NO
 124 CHM_FILE               =
 125 HHC_LOCATION           =
 126 GENERATE_CHI           = NO
 127 BINARY_TOC             = NO
 128 TOC_EXPAND             = NO
 129 DISABLE_INDEX          = NO
 130 ENUM_VALUES_PER_LINE   = 4
 131 GENERATE_TREEVIEW      = NO
 132 TREEVIEW_WIDTH         = 250
 133 #---------------------------------------------------------------------------
 134 # configuration options related to the LaTeX output
 135 #---------------------------------------------------------------------------
 136 GENERATE_LATEX         = NO
 137 LATEX_OUTPUT           = latex
 138 LATEX_CMD_NAME         = latex
 139 MAKEINDEX_CMD_NAME     = makeindex
 140 COMPACT_LATEX          = NO
 141 PAPER_TYPE             = a4wide
 142 EXTRA_PACKAGES         =
 143 LATEX_HEADER           =
 144 PDF_HYPERLINKS         = NO
 145 USE_PDFLATEX           = NO
 146 LATEX_BATCHMODE        = NO
 147 LATEX_HIDE_INDICES     = NO
 148 #---------------------------------------------------------------------------
 149 # configuration options related to the RTF output
 150 #---------------------------------------------------------------------------
 151 GENERATE_RTF           = NO
 152 RTF_OUTPUT             = rtf
 153 COMPACT_RTF            = NO
 154 RTF_HYPERLINKS         = NO
 155 RTF_STYLESHEET_FILE    =
 156 RTF_EXTENSIONS_FILE    =
 157 #---------------------------------------------------------------------------
 158 # configuration options related to the man page output
 159 #---------------------------------------------------------------------------
 160 GENERATE_MAN           = NO
 161 MAN_OUTPUT             = man
 162 MAN_EXTENSION          = .3
 163 MAN_LINKS              = NO
 164 #---------------------------------------------------------------------------
 165 # configuration options related to the XML output
 166 #---------------------------------------------------------------------------
 167 GENERATE_XML           = NO
 168 XML_OUTPUT             = xml
 169 XML_SCHEMA             =
 170 XML_DTD                =
 171 XML_PROGRAMLISTING     = YES
 172 #---------------------------------------------------------------------------
 173 # configuration options for the AutoGen Definitions output
 174 #---------------------------------------------------------------------------
 175 GENERATE_AUTOGEN_DEF   = NO
 176 #---------------------------------------------------------------------------
 177 # configuration options related to the Perl module output
 178 #---------------------------------------------------------------------------
 179 GENERATE_PERLMOD       = NO
 180 PERLMOD_LATEX          = NO
 181 PERLMOD_PRETTY         = YES
 182 PERLMOD_MAKEVAR_PREFIX =
 183 #---------------------------------------------------------------------------
 184 # Configuration options related to the preprocessor
 185 #---------------------------------------------------------------------------
 186 ENABLE_PREPROCESSING   = YES
 187 MACRO_EXPANSION        = NO
 188 EXPAND_ONLY_PREDEF     = NO
 189 SEARCH_INCLUDES        = YES
 190 INCLUDE_PATH           =
 191 INCLUDE_FILE_PATTERNS  =
 192 PREDEFINED             =
 193 EXPAND_AS_DEFINED      =
 194 SKIP_FUNCTION_MACROS   = YES
 195 #---------------------------------------------------------------------------
 196 # Configuration::additions related to external references
 197 #---------------------------------------------------------------------------
 198 TAGFILES               =
 199 GENERATE_TAGFILE       =
 200 ALLEXTERNALS           = NO
 201 EXTERNAL_GROUPS        = YES
 202 PERL_PATH              = /usr/bin/perl
 203 #---------------------------------------------------------------------------
 204 # Configuration options related to the dot tool
 205 #---------------------------------------------------------------------------
 206 CLASS_DIAGRAMS         = YES
 207 HIDE_UNDOC_RELATIONS   = YES
 208 HAVE_DOT               = NO
 209 CLASS_GRAPH            = YES
 210 COLLABORATION_GRAPH    = YES
 211 GROUP_GRAPHS           = YES
 212 UML_LOOK               = NO
 213 TEMPLATE_RELATIONS     = NO
 214 INCLUDE_GRAPH          = YES
 215 INCLUDED_BY_GRAPH      = YES
 216 CALL_GRAPH             = NO
 217 GRAPHICAL_HIERARCHY    = YES
 218 DIRECTORY_GRAPH        = YES
 219 DOT_IMAGE_FORMAT       = png
 220 DOT_PATH               =
 221 DOTFILE_DIRS           =
 222 MAX_DOT_GRAPH_WIDTH    = 1024
 223 MAX_DOT_GRAPH_HEIGHT   = 1024
 224 MAX_DOT_GRAPH_DEPTH    = 1000
 225 DOT_TRANSPARENT        = NO
 226 DOT_MULTI_TARGETS      = NO
 227 GENERATE_LEGEND        = YES
 228 DOT_CLEANUP            = YES
 229 #---------------------------------------------------------------------------
 230 # Configuration::additions related to the search engine
 231 #---------------------------------------------------------------------------
 232 SEARCHENGINE           = NO