doc/Doxyfile

   1 # Doxyfile 1.5.1
   2
   3 #---------------------------------------------------------------------------
   4 # Project related configuration options
   5 #---------------------------------------------------------------------------
   6 PROJECT_NAME           = "Re-Mote Mote Control Infrastructure"
   7 PROJECT_NUMBER         =
   8 OUTPUT_DIRECTORY       = code
   9 CREATE_SUBDIRS         = YES
  10 OUTPUT_LANGUAGE        = English
  11 USE_WINDOWS_ENCODING   = NO
  12 BRIEF_MEMBER_DESC      = YES
  13 REPEAT_BRIEF           = YES
  14 ABBREVIATE_BRIEF       =
  15 ALWAYS_DETAILED_SEC    = NO
  16 INLINE_INHERITED_MEMB  = NO
  17 FULL_PATH_NAMES        = NO
  18 STRIP_FROM_PATH        =
  19 STRIP_FROM_INC_PATH    =
  20 SHORT_NAMES            = NO
  21 JAVADOC_AUTOBRIEF      = YES
  22 MULTILINE_CPP_IS_BRIEF = NO
  23 DETAILS_AT_TOP         = NO
  24 INHERIT_DOCS           = YES
  25 SEPARATE_MEMBER_PAGES  = NO
  26 TAB_SIZE               = 8
  27 ALIASES                =
  28 OPTIMIZE_OUTPUT_FOR_C  = NO
  29 OPTIMIZE_OUTPUT_JAVA   = NO
  30 BUILTIN_STL_SUPPORT    = NO
  31 DISTRIBUTE_GROUP_DOC   = NO
  32 SUBGROUPING            = YES
  33 #---------------------------------------------------------------------------
  34 # Build related configuration options
  35 #---------------------------------------------------------------------------
  36 EXTRACT_ALL            = YES
  37 EXTRACT_PRIVATE        = YES
  38 EXTRACT_STATIC         = YES
  39 EXTRACT_LOCAL_CLASSES  = YES
  40 EXTRACT_LOCAL_METHODS  = NO
  41 HIDE_UNDOC_MEMBERS     = NO
  42 HIDE_UNDOC_CLASSES     = NO
  43 HIDE_FRIEND_COMPOUNDS  = NO
  44 HIDE_IN_BODY_DOCS      = NO
  45 INTERNAL_DOCS          = NO
  46 CASE_SENSE_NAMES       = YES
  47 HIDE_SCOPE_NAMES       = NO
  48 SHOW_INCLUDE_FILES     = YES
  49 INLINE_INFO            = YES
  50 SORT_MEMBER_DOCS       = YES
  51 SORT_BRIEF_DOCS        = NO
  52 SORT_BY_SCOPE_NAME     = NO
  53 GENERATE_TODOLIST      = YES
  54 GENERATE_TESTLIST      = YES
  55 GENERATE_BUGLIST       = YES
  56 GENERATE_DEPRECATEDLIST= YES
  57 ENABLED_SECTIONS       =
  58 MAX_INITIALIZER_LINES  = 30
  59 SHOW_USED_FILES        = YES
  60 SHOW_DIRECTORIES       = YES
  61 FILE_VERSION_FILTER    =
  62 #---------------------------------------------------------------------------
  63 # configuration options related to warning and progress messages
  64 #---------------------------------------------------------------------------
  65 QUIET                  = NO
  66 WARNINGS               = YES
  67 WARN_IF_UNDOCUMENTED   = YES
  68 WARN_IF_DOC_ERROR      = YES
  69 WARN_NO_PARAMDOC       = NO
  70 WARN_FORMAT            = "$file:$line: $text"
  71 WARN_LOGFILE           =
  72 #---------------------------------------------------------------------------
  73 # configuration options related to the input files
  74 #---------------------------------------------------------------------------
  75 INPUT                  = ../libutil \
  76                          ../mch \
  77                          ../mcs \
  78                          ../protocols
  79 FILE_PATTERNS          =
  80 RECURSIVE              = YES
  81 EXCLUDE                =
  82 EXCLUDE_SYMLINKS       = NO
  83 EXCLUDE_PATTERNS       =
  84 EXAMPLE_PATH           =
  85 EXAMPLE_PATTERNS       =
  86 EXAMPLE_RECURSIVE      = NO
  87 IMAGE_PATH             =
  88 INPUT_FILTER           =
  89 FILTER_PATTERNS        =
  90 FILTER_SOURCE_FILES    = NO
  91 #---------------------------------------------------------------------------
  92 # configuration options related to source browsing
  93 #---------------------------------------------------------------------------
  94 SOURCE_BROWSER         = NO
  95 INLINE_SOURCES         = NO
  96 STRIP_CODE_COMMENTS    = YES
  97 REFERENCED_BY_RELATION = NO
  98 REFERENCES_RELATION    = NO
  99 REFERENCES_LINK_SOURCE = NO
 100 USE_HTAGS              = NO
 101 VERBATIM_HEADERS       = YES
 102 #---------------------------------------------------------------------------
 103 # configuration options related to the alphabetical class index
 104 #---------------------------------------------------------------------------
 105 ALPHABETICAL_INDEX     = NO
 106 COLS_IN_ALPHA_INDEX    = 5
 107 IGNORE_PREFIX          =
 108 #---------------------------------------------------------------------------
 109 # configuration options related to the HTML output
 110 #---------------------------------------------------------------------------
 111 GENERATE_HTML          = YES
 112 HTML_OUTPUT            = html
 113 HTML_FILE_EXTENSION    = .html
 114 HTML_HEADER            =
 115 HTML_FOOTER            =
 116 HTML_STYLESHEET        =
 117 HTML_ALIGN_MEMBERS     = YES
 118 GENERATE_HTMLHELP      = NO
 119 CHM_FILE               =
 120 HHC_LOCATION           =
 121 GENERATE_CHI           = NO
 122 BINARY_TOC             = NO
 123 TOC_EXPAND             = NO
 124 DISABLE_INDEX          = NO
 125 ENUM_VALUES_PER_LINE   = 4
 126 GENERATE_TREEVIEW      = NO
 127 TREEVIEW_WIDTH         = 250
 128 #---------------------------------------------------------------------------
 129 # configuration options related to the LaTeX output
 130 #---------------------------------------------------------------------------
 131 GENERATE_LATEX         = NO
 132 #---------------------------------------------------------------------------
 133 # configuration options related to the RTF output
 134 #---------------------------------------------------------------------------
 135 GENERATE_RTF           = NO
 136 #---------------------------------------------------------------------------
 137 # configuration options related to the man page output
 138 #---------------------------------------------------------------------------
 139 GENERATE_MAN           = NO
 140 #---------------------------------------------------------------------------
 141 # configuration options related to the XML output
 142 #---------------------------------------------------------------------------
 143 GENERATE_XML           = NO
 144 #---------------------------------------------------------------------------
 145 # configuration options for the AutoGen Definitions output
 146 #---------------------------------------------------------------------------
 147 GENERATE_AUTOGEN_DEF   = NO
 148 #---------------------------------------------------------------------------
 149 # configuration options related to the Perl module output
 150 #---------------------------------------------------------------------------
 151 GENERATE_PERLMOD       = NO
 152 #---------------------------------------------------------------------------
 153 # Configuration options related to the preprocessor
 154 #---------------------------------------------------------------------------
 155 ENABLE_PREPROCESSING   = YES
 156 MACRO_EXPANSION        = NO
 157 EXPAND_ONLY_PREDEF     = NO
 158 SEARCH_INCLUDES        = YES
 159 INCLUDE_PATH           =
 160 INCLUDE_FILE_PATTERNS  =
 161 PREDEFINED             =
 162 EXPAND_AS_DEFINED      =
 163 SKIP_FUNCTION_MACROS   = YES
 164 #---------------------------------------------------------------------------
 165 # Configuration::additions related to external references
 166 #---------------------------------------------------------------------------
 167 TAGFILES               =
 168 GENERATE_TAGFILE       =
 169 ALLEXTERNALS           = NO
 170 EXTERNAL_GROUPS        = YES
 171 PERL_PATH              = /usr/bin/perl
 172 #---------------------------------------------------------------------------
 173 # Configuration options related to the dot tool
 174 #---------------------------------------------------------------------------
 175 CLASS_DIAGRAMS         = NO
 176 HIDE_UNDOC_RELATIONS   = YES
 177 HAVE_DOT               = YES
 178 CLASS_GRAPH            = YES
 179 COLLABORATION_GRAPH    = YES
 180 GROUP_GRAPHS           = NO
 181 UML_LOOK               = NO
 182 TEMPLATE_RELATIONS     = NO
 183 INCLUDE_GRAPH          = YES
 184 INCLUDED_BY_GRAPH      = NO
 185 CALL_GRAPH             = NO
 186 CALLER_GRAPH           = NO
 187 GRAPHICAL_HIERARCHY    = YES
 188 DIRECTORY_GRAPH        = YES
 189 DOT_IMAGE_FORMAT       = png
 190 DOT_PATH               = /usr/bin/
 191 DOTFILE_DIRS           =
 192 MAX_DOT_GRAPH_WIDTH    = 1024
 193 MAX_DOT_GRAPH_HEIGHT   = 1024
 194 MAX_DOT_GRAPH_DEPTH    = 0
 195 DOT_TRANSPARENT        = NO
 196 DOT_MULTI_TARGETS      = NO
 197 GENERATE_LEGEND        = YES
 198 DOT_CLEANUP            = YES
 199 #---------------------------------------------------------------------------
 200 # Configuration::additions related to the search engine
 201 #---------------------------------------------------------------------------
 202 SEARCHENGINE           = NO