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_Array.hxx \
  62                          MEDMEM_PointerOf.hxx \
  63                          MEDMEM_STRING.hxx \
  64                          MEDMEM_Utilities.hxx \
  65                          MEDMEM_Connectivity.cxx \
  66                          MEDMEM_Connectivity.hxx \
  67                          MEDMEM_Coordinate.cxx \
  68                          MEDMEM_Coordinate.hxx \
  69                          MEDMEM_ModulusArray.hxx
  70 EXAMPLE_PATH           =
  71 EXAMPLE_PATTERNS       =
  72 EXAMPLE_RECURSIVE      = NO
  73 IMAGE_PATH             =
  74 INPUT_FILTER           =
  75 FILTER_SOURCE_FILES    = NO
  76 #---------------------------------------------------------------------------
  77 # configuration options related to source browsing
  78 #---------------------------------------------------------------------------
  79 SOURCE_BROWSER         = NO
  80 INLINE_SOURCES         = NO
  81 REFERENCED_BY_RELATION = YES
  82 REFERENCES_RELATION    = YES
  83 #---------------------------------------------------------------------------
  84 # configuration options related to the alphabetical class index
  85 #---------------------------------------------------------------------------
  86 ALPHABETICAL_INDEX     = YES
  87 COLS_IN_ALPHA_INDEX    = 5
  88 IGNORE_PREFIX          =
  89 #---------------------------------------------------------------------------
  90 # configuration options related to the HTML output
  91 #---------------------------------------------------------------------------
  92 GENERATE_HTML          = YES
  93 HTML_OUTPUT            = html
  94 HTML_HEADER            =
  95 HTML_FOOTER            =
  96 HTML_STYLESHEET        =
  97 HTML_ALIGN_MEMBERS     = YES
  98 GENERATE_HTMLHELP      = YES
  99 GENERATE_CHI           = YES
 100 BINARY_TOC             = NO
 101 TOC_EXPAND             = YES
 102 DISABLE_INDEX          = NO
 103 ENUM_VALUES_PER_LINE   = 4
 104 GENERATE_TREEVIEW      = YES
 105 TREEVIEW_WIDTH         = 250
 106 #---------------------------------------------------------------------------
 107 # configuration options related to the LaTeX output
 108 #---------------------------------------------------------------------------
 109 GENERATE_LATEX         = YES
 110 LATEX_OUTPUT           = latex
 111 COMPACT_LATEX          = NO
 112 PAPER_TYPE             = a4wide
 113 EXTRA_PACKAGES         =
 114 LATEX_HEADER           =
 115 PDF_HYPERLINKS         = NO
 116 USE_PDFLATEX           = NO
 117 LATEX_BATCHMODE        = NO
 118 #---------------------------------------------------------------------------
 119 # configuration options related to the RTF output
 120 #---------------------------------------------------------------------------
 121 GENERATE_RTF           = NO
 122 RTF_OUTPUT             = rtf
 123 COMPACT_RTF            = NO
 124 RTF_HYPERLINKS         = NO
 125 RTF_STYLESHEET_FILE    =
 126 RTF_EXTENSIONS_FILE    =
 127 #---------------------------------------------------------------------------
 128 # configuration options related to the man page output
 129 #---------------------------------------------------------------------------
 130 GENERATE_MAN           = NO
 131 MAN_OUTPUT             = man
 132 MAN_EXTENSION          = .3
 133 MAN_LINKS              = NO
 134 #---------------------------------------------------------------------------
 135 # configuration options related to the XML output
 136 #---------------------------------------------------------------------------
 137 GENERATE_XML           = NO
 138 #---------------------------------------------------------------------------
 139 # Configuration options related to the preprocessor
 140 #---------------------------------------------------------------------------
 141 ENABLE_PREPROCESSING   = YES
 142 MACRO_EXPANSION        = NO
 143 EXPAND_ONLY_PREDEF     = NO
 144 SEARCH_INCLUDES        = YES
 145 INCLUDE_PATH           =
 146 INCLUDE_FILE_PATTERNS  =
 147 PREDEFINED             =
 148 EXPAND_AS_DEFINED      =
 149 SKIP_FUNCTION_MACROS   = YES
 150 #---------------------------------------------------------------------------
 151 # Configuration::addtions related to external references
 152 #---------------------------------------------------------------------------
 153 TAGFILES               =
 154 GENERATE_TAGFILE       =
 155 ALLEXTERNALS           = NO
 156 PERL_PATH              = /usr/bin/perl
 157 #---------------------------------------------------------------------------
 158 # Configuration options related to the dot tool
 159 #---------------------------------------------------------------------------
 160 CLASS_DIAGRAMS         = YES
 161 HAVE_DOT               = YES
 162 CLASS_GRAPH            = YES
 163 COLLABORATION_GRAPH    = YES
 164 TEMPLATE_RELATIONS     = YES
 165 HIDE_UNDOC_RELATIONS   = YES
 166 INCLUDE_GRAPH          = YES
 167 INCLUDED_BY_GRAPH      = YES
 168 GRAPHICAL_HIERARCHY    = YES
 169 DOT_PATH               =
 170 DOTFILE_DIRS           =
 171 MAX_DOT_GRAPH_WIDTH    = 1024
 172 MAX_DOT_GRAPH_HEIGHT   = 1024
 173 GENERATE_LEGEND        = YES
 174 DOT_CLEANUP            = YES
 175 #---------------------------------------------------------------------------
 176 # Configuration::addtions related to the search engine
 177 #---------------------------------------------------------------------------
 178 SEARCHENGINE           = NO
 179 CGI_NAME               = search.cgi
 180 CGI_URL                =
 181 DOC_URL                =
 182 DOC_ABSPATH            =
 183 BIN_ABSPATH            = /usr/local/bin/
 184 EXT_DOC_PATHS          =