doc/Doxyfile.dox.cmake.in

   1 # Doxyfile 1.7.3
   2
   3 #---------------------------------------------------------------------------
   4 # Project related configuration options
   5 #---------------------------------------------------------------------------
   6 DOXYFILE_ENCODING      = UTF-8
   7 PROJECT_NAME           = OpenJPEG
   8 PROJECT_NUMBER         = @OPENJPEG_VERSION@
   9 PROJECT_BRIEF          =
  10 PROJECT_LOGO           =
  11 OUTPUT_DIRECTORY       = @OPENJPEG_BINARY_DIR@/doc
  12 CREATE_SUBDIRS         = NO
  13 OUTPUT_LANGUAGE        = English
  14 BRIEF_MEMBER_DESC      = YES
  15 REPEAT_BRIEF           = YES
  16 ABBREVIATE_BRIEF       = "The $name class" \
  17                          "The $name widget" \
  18                          "The $name file" \
  19                          is \
  20                          provides \
  21                          specifies \
  22                          contains \
  23                          represents \
  24                          a \
  25                          an \
  26                          the
  27 ALWAYS_DETAILED_SEC    = NO
  28 INLINE_INHERITED_MEMB  = NO
  29 FULL_PATH_NAMES        = NO
  30 STRIP_FROM_PATH        = C://
  31 STRIP_FROM_INC_PATH    =
  32 SHORT_NAMES            = NO
  33 JAVADOC_AUTOBRIEF      = YES
  34 QT_AUTOBRIEF           = NO
  35 MULTILINE_CPP_IS_BRIEF = NO
  36 INHERIT_DOCS           = YES
  37 SEPARATE_MEMBER_PAGES  = NO
  38 TAB_SIZE               = 8
  39 ALIASES                =
  40 OPTIMIZE_OUTPUT_FOR_C  = YES
  41 OPTIMIZE_OUTPUT_JAVA   = NO
  42 OPTIMIZE_FOR_FORTRAN   = NO
  43 OPTIMIZE_OUTPUT_VHDL   = NO
  44 EXTENSION_MAPPING      =
  45 BUILTIN_STL_SUPPORT    = NO
  46 CPP_CLI_SUPPORT        = NO
  47 SIP_SUPPORT            = NO
  48 IDL_PROPERTY_SUPPORT   = YES
  49 DISTRIBUTE_GROUP_DOC   = NO
  50 SUBGROUPING            = YES
  51 TYPEDEF_HIDES_STRUCT   = NO
  52 SYMBOL_CACHE_SIZE      = 0
  53 #---------------------------------------------------------------------------
  54 # Build related configuration options
  55 #---------------------------------------------------------------------------
  56 EXTRACT_ALL            = YES
  57 EXTRACT_PRIVATE        = YES
  58 EXTRACT_STATIC         = YES
  59 EXTRACT_LOCAL_CLASSES  = YES
  60 EXTRACT_LOCAL_METHODS  = NO
  61 EXTRACT_ANON_NSPACES   = NO
  62 HIDE_UNDOC_MEMBERS     = NO
  63 HIDE_UNDOC_CLASSES     = NO
  64 HIDE_FRIEND_COMPOUNDS  = NO
  65 HIDE_IN_BODY_DOCS      = NO
  66 INTERNAL_DOCS          = NO
  67 CASE_SENSE_NAMES       = NO
  68 HIDE_SCOPE_NAMES       = NO
  69 SHOW_INCLUDE_FILES     = YES
  70 FORCE_LOCAL_INCLUDES   = NO
  71 INLINE_INFO            = YES
  72 SORT_MEMBER_DOCS       = YES
  73 SORT_BRIEF_DOCS        = NO
  74 SORT_MEMBERS_CTORS_1ST = NO
  75 SORT_GROUP_NAMES       = NO
  76 SORT_BY_SCOPE_NAME     = NO
  77 STRICT_PROTO_MATCHING  = NO
  78 GENERATE_TODOLIST      = YES
  79 GENERATE_TESTLIST      = YES
  80 GENERATE_BUGLIST       = YES
  81 GENERATE_DEPRECATEDLIST= YES
  82 ENABLED_SECTIONS       =
  83 MAX_INITIALIZER_LINES  = 30
  84 SHOW_USED_FILES        = YES
  85 SHOW_DIRECTORIES       = NO
  86 SHOW_FILES             = YES
  87 SHOW_NAMESPACES        = YES
  88 FILE_VERSION_FILTER    =
  89 LAYOUT_FILE            =
  90 #---------------------------------------------------------------------------
  91 # configuration options related to warning and progress messages
  92 #---------------------------------------------------------------------------
  93 QUIET                  = NO
  94 WARNINGS               = YES
  95 WARN_IF_UNDOCUMENTED   = YES
  96 WARN_IF_DOC_ERROR      = YES
  97 WARN_NO_PARAMDOC       = NO
  98 WARN_FORMAT            = "$file:$line: $text"
  99 WARN_LOGFILE           =
 100 #---------------------------------------------------------------------------
 101 # configuration options related to the input files
 102 #---------------------------------------------------------------------------
 103 INPUT                  = @OPENJPEG_SOURCE_DIR@/src/lib \
 104                          @OPENJPEG_BINARY_DIR@/doc
 105 INPUT_ENCODING         = UTF-8
 106 FILE_PATTERNS          = *.h \
 107                          *.c \
 108                          *.dox
 109 RECURSIVE              = YES
 110 EXCLUDE                =
 111 EXCLUDE_SYMLINKS       = NO
 112 EXCLUDE_PATTERNS       = .svn
 113 EXCLUDE_SYMBOLS        =
 114 EXAMPLE_PATH           =
 115 EXAMPLE_PATTERNS       = *
 116 EXAMPLE_RECURSIVE      = NO
 117 IMAGE_PATH             =
 118 INPUT_FILTER           =
 119 FILTER_PATTERNS        =
 120 FILTER_SOURCE_FILES    = NO
 121 FILTER_SOURCE_PATTERNS =
 122 #---------------------------------------------------------------------------
 123 # configuration options related to source browsing
 124 #---------------------------------------------------------------------------
 125 SOURCE_BROWSER         = NO
 126 INLINE_SOURCES         = NO
 127 STRIP_CODE_COMMENTS    = YES
 128 REFERENCED_BY_RELATION = YES
 129 REFERENCES_RELATION    = YES
 130 REFERENCES_LINK_SOURCE = YES
 131 USE_HTAGS              = NO
 132 VERBATIM_HEADERS       = YES
 133 #---------------------------------------------------------------------------
 134 # configuration options related to the alphabetical class index
 135 #---------------------------------------------------------------------------
 136 ALPHABETICAL_INDEX     = NO
 137 COLS_IN_ALPHA_INDEX    = 5
 138 IGNORE_PREFIX          =
 139 #---------------------------------------------------------------------------
 140 # configuration options related to the HTML output
 141 #---------------------------------------------------------------------------
 142 GENERATE_HTML          = YES
 143 HTML_OUTPUT            = ./html
 144 HTML_FILE_EXTENSION    = .html
 145 HTML_HEADER            =
 146 HTML_FOOTER            =
 147 HTML_STYLESHEET        =
 148 HTML_COLORSTYLE_HUE    = 220
 149 HTML_COLORSTYLE_SAT    = 100
 150 HTML_COLORSTYLE_GAMMA  = 80
 151 HTML_TIMESTAMP         = YES
 152 HTML_ALIGN_MEMBERS     = YES
 153 HTML_DYNAMIC_SECTIONS  = NO
 154 GENERATE_DOCSET        = NO
 155 DOCSET_FEEDNAME        = "Doxygen generated docs"
 156 DOCSET_BUNDLE_ID       = org.doxygen.Project
 157 DOCSET_PUBLISHER_ID    = org.doxygen.Publisher
 158 DOCSET_PUBLISHER_NAME  = Publisher
 159 GENERATE_HTMLHELP      = NO
 160 CHM_FILE               =
 161 HHC_LOCATION           =
 162 GENERATE_CHI           = NO
 163 CHM_INDEX_ENCODING     =
 164 BINARY_TOC             = NO
 165 TOC_EXPAND             = NO
 166 GENERATE_QHP           = NO
 167 QCH_FILE               =
 168 QHP_NAMESPACE          = org.doxygen.Project
 169 QHP_VIRTUAL_FOLDER     = doc
 170 QHP_CUST_FILTER_NAME   =
 171 QHP_CUST_FILTER_ATTRS  =
 172 QHP_SECT_FILTER_ATTRS  =
 173 QHG_LOCATION           =
 174 GENERATE_ECLIPSEHELP   = NO
 175 ECLIPSE_DOC_ID         = org.doxygen.Project
 176 DISABLE_INDEX          = NO
 177 ENUM_VALUES_PER_LINE   = 4
 178 GENERATE_TREEVIEW      = NO
 179 USE_INLINE_TREES       = NO
 180 TREEVIEW_WIDTH         = 250
 181 EXT_LINKS_IN_WINDOW    = NO
 182 FORMULA_FONTSIZE       = 10
 183 FORMULA_TRANSPARENT    = YES
 184 USE_MATHJAX            = NO
 185 MATHJAX_RELPATH        = http://www.mathjax.org/mathjax
 186 SEARCHENGINE           = NO
 187 SERVER_BASED_SEARCH    = NO
 188 #---------------------------------------------------------------------------
 189 # configuration options related to the LaTeX output
 190 #---------------------------------------------------------------------------
 191 GENERATE_LATEX         = NO
 192 LATEX_OUTPUT           = latex
 193 LATEX_CMD_NAME         = latex
 194 MAKEINDEX_CMD_NAME     = makeindex
 195 COMPACT_LATEX          = NO
 196 PAPER_TYPE             = a4wide
 197 EXTRA_PACKAGES         =
 198 LATEX_HEADER           =
 199 PDF_HYPERLINKS         = NO
 200 USE_PDFLATEX           = NO
 201 LATEX_BATCHMODE        = NO
 202 LATEX_HIDE_INDICES     = NO
 203 LATEX_SOURCE_CODE      = NO
 204 #---------------------------------------------------------------------------
 205 # configuration options related to the RTF output
 206 #---------------------------------------------------------------------------
 207 GENERATE_RTF           = NO
 208 RTF_OUTPUT             = rtf
 209 COMPACT_RTF            = NO
 210 RTF_HYPERLINKS         = NO
 211 RTF_STYLESHEET_FILE    =
 212 RTF_EXTENSIONS_FILE    =
 213 #---------------------------------------------------------------------------
 214 # configuration options related to the man page output
 215 #---------------------------------------------------------------------------
 216 GENERATE_MAN           = NO
 217 MAN_OUTPUT             = man
 218 MAN_EXTENSION          = .3
 219 MAN_LINKS              = NO
 220 #---------------------------------------------------------------------------
 221 # configuration options related to the XML output
 222 #---------------------------------------------------------------------------
 223 GENERATE_XML           = NO
 224 XML_OUTPUT             = xml
 225 XML_SCHEMA             =
 226 XML_DTD                =
 227 XML_PROGRAMLISTING     = YES
 228 #---------------------------------------------------------------------------
 229 # configuration options for the AutoGen Definitions output
 230 #---------------------------------------------------------------------------
 231 GENERATE_AUTOGEN_DEF   = NO
 232 #---------------------------------------------------------------------------
 233 # configuration options related to the Perl module output
 234 #---------------------------------------------------------------------------
 235 GENERATE_PERLMOD       = NO
 236 PERLMOD_LATEX          = NO
 237 PERLMOD_PRETTY         = YES
 238 PERLMOD_MAKEVAR_PREFIX =
 239 #---------------------------------------------------------------------------
 240 # Configuration options related to the preprocessor
 241 #---------------------------------------------------------------------------
 242 ENABLE_PREPROCESSING   = YES
 243 MACRO_EXPANSION        = NO
 244 EXPAND_ONLY_PREDEF     = NO
 245 SEARCH_INCLUDES        = YES
 246 INCLUDE_PATH           =
 247 INCLUDE_FILE_PATTERNS  =
 248 PREDEFINED             = USE_JPWL \
 249                          USE_JPSEC
 250 EXPAND_AS_DEFINED      =
 251 SKIP_FUNCTION_MACROS   = YES
 252 #---------------------------------------------------------------------------
 253 # Configuration::additions related to external references
 254 #---------------------------------------------------------------------------
 255 TAGFILES               =
 256 GENERATE_TAGFILE       =
 257 ALLEXTERNALS           = NO
 258 EXTERNAL_GROUPS        = YES
 259 PERL_PATH              = /usr/bin/perl
 260 #---------------------------------------------------------------------------
 261 # Configuration options related to the dot tool
 262 #---------------------------------------------------------------------------
 263 CLASS_DIAGRAMS         = YES
 264 MSCGEN_PATH            =
 265 HIDE_UNDOC_RELATIONS   = YES
 266 HAVE_DOT               = NO
 267 DOT_NUM_THREADS        = 0
 268 DOT_FONTNAME           = Helvetica
 269 DOT_FONTSIZE           = 10
 270 DOT_FONTPATH           =
 271 CLASS_GRAPH            = YES
 272 COLLABORATION_GRAPH    = YES
 273 GROUP_GRAPHS           = YES
 274 UML_LOOK               = NO
 275 TEMPLATE_RELATIONS     = NO
 276 INCLUDE_GRAPH          = YES
 277 INCLUDED_BY_GRAPH      = YES
 278 CALL_GRAPH             = NO
 279 CALLER_GRAPH           = NO
 280 GRAPHICAL_HIERARCHY    = YES
 281 DIRECTORY_GRAPH        = YES
 282 DOT_IMAGE_FORMAT       = png
 283 DOT_PATH               =
 284 DOTFILE_DIRS           =
 285 MSCFILE_DIRS           =
 286 DOT_GRAPH_MAX_NODES    = 50
 287 MAX_DOT_GRAPH_DEPTH    = 1000
 288 DOT_TRANSPARENT        = NO
 289 DOT_MULTI_TARGETS      = NO
 290 GENERATE_LEGEND        = YES
 291 DOT_CLEANUP            = YES