kmetadata/Doxyfile.cmake

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