doc/Doxyfile.dox.cmake.in

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