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