src/MEDMEM/Doxyfile_med_user.in

   1 # Doxyfile 0.1
   2
   3 #---------------------------------------------------------------------------
   4 # General configuration options
   5 #---------------------------------------------------------------------------
   6 PROJECT_NAME           = "Med Memory Users'"
   7 PROJECT_NUMBER         = 1.0.2
   8 OUTPUT_DIRECTORY       = doc_ref_user
   9 OUTPUT_LANGUAGE        = English
  10 EXTRACT_ALL            = YES
  11 EXTRACT_PRIVATE        = NO
  12 EXTRACT_STATIC         = NO
  13 HIDE_UNDOC_MEMBERS     = YES
  14 HIDE_UNDOC_CLASSES     = YES
  15 BRIEF_MEMBER_DESC      = NO
  16 REPEAT_BRIEF           = YES
  17 ALWAYS_DETAILED_SEC    = NO
  18 FULL_PATH_NAMES        = NO
  19 STRIP_FROM_PATH        =
  20 INTERNAL_DOCS          = NO
  21 STRIP_CODE_COMMENTS    = YES
  22 CASE_SENSE_NAMES       = YES
  23 SHORT_NAMES            = NO
  24 HIDE_SCOPE_NAMES       = NO
  25 VERBATIM_HEADERS       = NO
  26 SHOW_INCLUDE_FILES     = NO
  27 JAVADOC_AUTOBRIEF      = NO
  28 INHERIT_DOCS           = YES
  29 INLINE_INFO            = NO
  30 SORT_MEMBER_DOCS       = NO
  31 DISTRIBUTE_GROUP_DOC   = NO
  32 TAB_SIZE               = 8
  33 GENERATE_TODOLIST      = YES
  34 GENERATE_TESTLIST      = YES
  35 GENERATE_BUGLIST       = YES
  36 ALIASES                =
  37 ENABLED_SECTIONS       =
  38 MAX_INITIALIZER_LINES  = 30
  39 OPTIMIZE_OUTPUT_FOR_C  = NO
  40 SHOW_USED_FILES        = NO
  41 #---------------------------------------------------------------------------
  42 # configuration options related to warning and progress messages
  43 #---------------------------------------------------------------------------
  44 QUIET                  = NO
  45 WARNINGS               = YES
  46 WARN_IF_UNDOCUMENTED   = YES
  47 WARN_FORMAT            = "$file:$line: $text"
  48 WARN_LOGFILE           = log_user
  49 #---------------------------------------------------------------------------
  50 # configuration options related to the input files
  51 #---------------------------------------------------------------------------
  52 INPUT                  = @srcdir@
  53 FILE_PATTERNS          = MEDMEM*.hxx \
  54                          MEDMEM*.cxx
  55 RECURSIVE              = NO
  56 EXCLUDE                = CVS
  57 EXCLUDE_PATTERNS       = MEDMEM_DriversDef.* \
  58                          MEDMEM_DriverTools.* \
  59                          MEDMEM_SkyLineArray.* \
  60                          MEDMEM_TypeMeshDriver.* \
  61                          MEDMEM_CellModel.* \
  62                          MEDMEM_Exception.* \
  63                          MEDMEM_GenDriver.* \
  64                          MEDMEM_Array.hxx \
  65                          MEDMEM_PointerOf.hxx \
  66                          MEDMEM_STRING.hxx \
  67                          MEDMEM_Utilities.hxx \
  68                          MEDMEM_Connectivity.cxx \
  69                          MEDMEM_Connectivity.hxx \
  70                          MEDMEM_Coordinate.cxx \
  71                          MEDMEM_Coordinate.hxx \
  72                          MEDMEM_ModulusArray.hxx
  73 EXAMPLE_PATH           =
  74 EXAMPLE_PATTERNS       =
  75 EXAMPLE_RECURSIVE      = NO
  76 IMAGE_PATH             =
  77 INPUT_FILTER           =
  78 FILTER_SOURCE_FILES    = NO
  79 #---------------------------------------------------------------------------
  80 # configuration options related to source browsing
  81 #---------------------------------------------------------------------------
  82 SOURCE_BROWSER         = NO
  83 INLINE_SOURCES         = NO
  84 REFERENCED_BY_RELATION = YES
  85 REFERENCES_RELATION    = YES
  86 #---------------------------------------------------------------------------
  87 # configuration options related to the alphabetical class index
  88 #---------------------------------------------------------------------------
  89 ALPHABETICAL_INDEX     = YES
  90 COLS_IN_ALPHA_INDEX    = 5
  91 IGNORE_PREFIX          =
  92 #---------------------------------------------------------------------------
  93 # configuration options related to the HTML output
  94 #---------------------------------------------------------------------------
  95 GENERATE_HTML          = YES
  96 HTML_OUTPUT            = html
  97 HTML_HEADER            =
  98 HTML_FOOTER            =
  99 HTML_STYLESHEET        =
 100 HTML_ALIGN_MEMBERS     = YES
 101 GENERATE_HTMLHELP      = YES
 102 GENERATE_CHI           = YES
 103 BINARY_TOC             = NO
 104 TOC_EXPAND             = YES
 105 DISABLE_INDEX          = NO
 106 ENUM_VALUES_PER_LINE   = 4
 107 GENERATE_TREEVIEW      = YES
 108 TREEVIEW_WIDTH         = 250
 109 #---------------------------------------------------------------------------
 110 # configuration options related to the LaTeX output
 111 #---------------------------------------------------------------------------
 112 GENERATE_LATEX         = YES
 113 LATEX_OUTPUT           = latex
 114 COMPACT_LATEX          = NO
 115 PAPER_TYPE             = a4wide
 116 EXTRA_PACKAGES         =
 117 LATEX_HEADER           =
 118 PDF_HYPERLINKS         = NO
 119 USE_PDFLATEX           = NO
 120 LATEX_BATCHMODE        = NO
 121 #---------------------------------------------------------------------------
 122 # configuration options related to the RTF output
 123 #---------------------------------------------------------------------------
 124 GENERATE_RTF           = NO
 125 RTF_OUTPUT             = rtf
 126 COMPACT_RTF            = NO
 127 RTF_HYPERLINKS         = NO
 128 RTF_STYLESHEET_FILE    =
 129 RTF_EXTENSIONS_FILE    =
 130 #---------------------------------------------------------------------------
 131 # configuration options related to the man page output
 132 #---------------------------------------------------------------------------
 133 GENERATE_MAN           = NO
 134 MAN_OUTPUT             = man
 135 MAN_EXTENSION          = .3
 136 MAN_LINKS              = NO
 137 #---------------------------------------------------------------------------
 138 # configuration options related to the XML output
 139 #---------------------------------------------------------------------------
 140 GENERATE_XML           = NO
 141 #---------------------------------------------------------------------------
 142 # Configuration options related to the preprocessor
 143 #---------------------------------------------------------------------------
 144 ENABLE_PREPROCESSING   = YES
 145 MACRO_EXPANSION        = NO
 146 EXPAND_ONLY_PREDEF     = NO
 147 SEARCH_INCLUDES        = YES
 148 INCLUDE_PATH           =
 149 INCLUDE_FILE_PATTERNS  =
 150 PREDEFINED             =
 151 EXPAND_AS_DEFINED      =
 152 SKIP_FUNCTION_MACROS   = YES
 153 #---------------------------------------------------------------------------
 154 # Configuration::addtions related to external references
 155 #---------------------------------------------------------------------------
 156 TAGFILES               =
 157 GENERATE_TAGFILE       =
 158 ALLEXTERNALS           = NO
 159 PERL_PATH              = /usr/bin/perl
 160 #---------------------------------------------------------------------------
 161 # Configuration options related to the dot tool
 162 #---------------------------------------------------------------------------
 163 CLASS_DIAGRAMS         = YES
 164 HAVE_DOT               = YES
 165 CLASS_GRAPH            = YES
 166 COLLABORATION_GRAPH    = YES
 167 TEMPLATE_RELATIONS     = YES
 168 HIDE_UNDOC_RELATIONS   = YES
 169 INCLUDE_GRAPH          = YES
 170 INCLUDED_BY_GRAPH      = YES
 171 GRAPHICAL_HIERARCHY    = YES
 172 DOT_PATH               =
 173 DOTFILE_DIRS           =
 174 MAX_DOT_GRAPH_WIDTH    = 1024
 175 MAX_DOT_GRAPH_HEIGHT   = 1024
 176 GENERATE_LEGEND        = YES
 177 DOT_CLEANUP            = YES
 178 #---------------------------------------------------------------------------
 179 # Configuration::addtions related to the search engine
 180 #---------------------------------------------------------------------------
 181 SEARCHENGINE           = NO
 182 CGI_NAME               = search.cgi
 183 CGI_URL                =
 184 DOC_URL                =
 185 DOC_ABSPATH            =
 186 BIN_ABSPATH            = /usr/local/bin/
 187 EXT_DOC_PATHS          =