uiacceltk/hitchcock/coretoolkit/group/Doxyfile.txt
changeset 0 15bf7259bb7c
equal deleted inserted replaced
-1:000000000000 0:15bf7259bb7c
       
     1 # Doxyfile 1.5.1-p1
       
     2 
       
     3 #---------------------------------------------------------------------------
       
     4 # Project related configuration options
       
     5 #---------------------------------------------------------------------------
       
     6 PROJECT_NAME           = "Hitchcock User Interface Toolkit"
       
     7 PROJECT_NUMBER         = 
       
     8 OUTPUT_DIRECTORY       = ../doc/api
       
     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    = NO
       
    26 INLINE_INHERITED_MEMB  = NO
       
    27 FULL_PATH_NAMES        = NO
       
    28 STRIP_FROM_PATH        = 
       
    29 STRIP_FROM_INC_PATH    = 
       
    30 SHORT_NAMES            = NO
       
    31 JAVADOC_AUTOBRIEF      = YES
       
    32 MULTILINE_CPP_IS_BRIEF = NO
       
    33 DETAILS_AT_TOP         = YES
       
    34 INHERIT_DOCS           = YES
       
    35 SEPARATE_MEMBER_PAGES  = NO
       
    36 TAB_SIZE               = 4
       
    37 ALIASES                = panic=@exception \
       
    38                          leave=@exception \
       
    39                          "internalTechnology=@par Internal technology" \
       
    40                          "internalComponent=@par Internal component" \
       
    41                          "internalAll=@par Internal all" \
       
    42                          "publishedPartner=@par Published-partner" \
       
    43                          "publishedAll=@par Published-all" \
       
    44                          "prototype=@par Prototype" \
       
    45                          "interim=@par Interim" \
       
    46                          "released=@par Released" \
       
    47                          "removed=@par Removed" \
       
    48                          "test=@par Test" \
       
    49                          "realtime=@par Realtime" \
       
    50                          "beginAPI=@name Exported API\n @{" \
       
    51                          endAPI=@}
       
    52 OPTIMIZE_OUTPUT_FOR_C  = NO
       
    53 OPTIMIZE_OUTPUT_JAVA   = NO
       
    54 BUILTIN_STL_SUPPORT    = NO
       
    55 DISTRIBUTE_GROUP_DOC   = NO
       
    56 SUBGROUPING            = YES
       
    57 #---------------------------------------------------------------------------
       
    58 # Build related configuration options
       
    59 #---------------------------------------------------------------------------
       
    60 EXTRACT_ALL            = YES
       
    61 EXTRACT_PRIVATE        = YES
       
    62 EXTRACT_STATIC         = YES
       
    63 EXTRACT_LOCAL_CLASSES  = YES
       
    64 EXTRACT_LOCAL_METHODS  = YES
       
    65 HIDE_UNDOC_MEMBERS     = NO
       
    66 HIDE_UNDOC_CLASSES     = NO
       
    67 HIDE_FRIEND_COMPOUNDS  = NO
       
    68 HIDE_IN_BODY_DOCS      = NO
       
    69 INTERNAL_DOCS          = NO
       
    70 CASE_SENSE_NAMES       = NO
       
    71 HIDE_SCOPE_NAMES       = NO
       
    72 SHOW_INCLUDE_FILES     = YES
       
    73 INLINE_INFO            = YES
       
    74 SORT_MEMBER_DOCS       = YES
       
    75 SORT_BRIEF_DOCS        = YES
       
    76 SORT_BY_SCOPE_NAME     = NO
       
    77 GENERATE_TODOLIST      = YES
       
    78 GENERATE_TESTLIST      = YES
       
    79 GENERATE_BUGLIST       = YES
       
    80 GENERATE_DEPRECATEDLIST= YES
       
    81 ENABLED_SECTIONS       = 
       
    82 MAX_INITIALIZER_LINES  = 30
       
    83 SHOW_USED_FILES        = YES
       
    84 SHOW_DIRECTORIES       = YES
       
    85 FILE_VERSION_FILTER    = 
       
    86 #---------------------------------------------------------------------------
       
    87 # configuration options related to warning and progress messages
       
    88 #---------------------------------------------------------------------------
       
    89 QUIET                  = NO
       
    90 WARNINGS               = YES
       
    91 WARN_IF_UNDOCUMENTED   = YES
       
    92 WARN_IF_DOC_ERROR      = YES
       
    93 WARN_NO_PARAMDOC       = NO
       
    94 WARN_FORMAT            = "$file:$line: $text"
       
    95 WARN_LOGFILE           = 
       
    96 #---------------------------------------------------------------------------
       
    97 # configuration options related to the input files
       
    98 #---------------------------------------------------------------------------
       
    99 INPUT                  = ../inc \
       
   100                          ../src \
       
   101                          ../../client/inc \
       
   102                          ../../client/src \
       
   103                          /s60/mw/uiaccelerator/uiaccelerator_dom/alf_visual_api/inc/alf \
       
   104                          /s60/mw/uiaccelerator/uiaccelerator_dom/alf_client_server_api/inc/alf \
       
   105                          /s60/mw/uiaccelerator/uiaccelerator_dom/alf_core_toolkit_api/inc/uiacceltk \
       
   106                          /s60/mw/uiaccelerator/uiaccelerator_dom/alf_extended_visual_api/inc/alf \
       
   107                          /s60/mw/uiaccelerator/uiaccelerator_dom/alf_extension_api/inc/alf \
       
   108                          /s60/mw/uiaccelerator/uiaccelerator_dom/alf_scrollbarwidget_api/inc/alf \
       
   109                          /s60/mw/uiaccelerator/uiaccelerator_dom/alf_tracing_api/inc/alf \
       
   110                          /s60/mw/uiaccelerator/uiaccelerator_dom/alf_tracing_api/inc/uiacceltk
       
   111 FILE_PATTERNS          = *.c \
       
   112                          *.cc \
       
   113                          *.cpp \
       
   114                          *.h \
       
   115                          *.hh \
       
   116                          *.hrh \
       
   117                          *.dox
       
   118 RECURSIVE              = YES
       
   119 EXCLUDE                = 
       
   120 EXCLUDE_SYMLINKS       = NO
       
   121 EXCLUDE_PATTERNS       = *Bitgdi* \
       
   122                          *Gles10* \
       
   123                          *Gles11* \
       
   124                          *MatrixStack* \
       
   125                          *blitter*
       
   126 EXAMPLE_PATH           = 
       
   127 EXAMPLE_PATTERNS       = 
       
   128 EXAMPLE_RECURSIVE      = NO
       
   129 IMAGE_PATH             = 
       
   130 INPUT_FILTER           = 
       
   131 FILTER_PATTERNS        = 
       
   132 FILTER_SOURCE_FILES    = NO
       
   133 #---------------------------------------------------------------------------
       
   134 # configuration options related to source browsing
       
   135 #---------------------------------------------------------------------------
       
   136 SOURCE_BROWSER         = YES
       
   137 INLINE_SOURCES         = NO
       
   138 STRIP_CODE_COMMENTS    = YES
       
   139 REFERENCED_BY_RELATION = YES
       
   140 REFERENCES_RELATION    = YES
       
   141 REFERENCES_LINK_SOURCE = YES
       
   142 USE_HTAGS              = NO
       
   143 VERBATIM_HEADERS       = YES
       
   144 #---------------------------------------------------------------------------
       
   145 # configuration options related to the alphabetical class index
       
   146 #---------------------------------------------------------------------------
       
   147 ALPHABETICAL_INDEX     = YES
       
   148 COLS_IN_ALPHA_INDEX    = 3
       
   149 IGNORE_PREFIX          = THui \
       
   150                          SHui \
       
   151                          CHui \
       
   152                          RHui \
       
   153                          MHui \
       
   154                          CAlf \
       
   155                          TAlf \
       
   156                          MAlf \
       
   157                          RAlf
       
   158 #---------------------------------------------------------------------------
       
   159 # configuration options related to the HTML output
       
   160 #---------------------------------------------------------------------------
       
   161 GENERATE_HTML          = YES
       
   162 HTML_OUTPUT            = html
       
   163 HTML_FILE_EXTENSION    = .html
       
   164 HTML_HEADER            = 
       
   165 HTML_FOOTER            = 
       
   166 HTML_STYLESHEET        = 
       
   167 HTML_ALIGN_MEMBERS     = YES
       
   168 GENERATE_HTMLHELP      = YES
       
   169 CHM_FILE               = 
       
   170 HHC_LOCATION           = 
       
   171 GENERATE_CHI           = NO
       
   172 BINARY_TOC             = NO
       
   173 TOC_EXPAND             = NO
       
   174 DISABLE_INDEX          = NO
       
   175 ENUM_VALUES_PER_LINE   = 4
       
   176 GENERATE_TREEVIEW      = NO
       
   177 TREEVIEW_WIDTH         = 250
       
   178 #---------------------------------------------------------------------------
       
   179 # configuration options related to the LaTeX output
       
   180 #---------------------------------------------------------------------------
       
   181 GENERATE_LATEX         = NO
       
   182 LATEX_OUTPUT           = latex
       
   183 LATEX_CMD_NAME         = latex
       
   184 MAKEINDEX_CMD_NAME     = makeindex
       
   185 COMPACT_LATEX          = NO
       
   186 PAPER_TYPE             = a4wide
       
   187 EXTRA_PACKAGES         = 
       
   188 LATEX_HEADER           = 
       
   189 PDF_HYPERLINKS         = NO
       
   190 USE_PDFLATEX           = NO
       
   191 LATEX_BATCHMODE        = NO
       
   192 LATEX_HIDE_INDICES     = NO
       
   193 #---------------------------------------------------------------------------
       
   194 # configuration options related to the RTF output
       
   195 #---------------------------------------------------------------------------
       
   196 GENERATE_RTF           = NO
       
   197 RTF_OUTPUT             = rtf
       
   198 COMPACT_RTF            = NO
       
   199 RTF_HYPERLINKS         = NO
       
   200 RTF_STYLESHEET_FILE    = 
       
   201 RTF_EXTENSIONS_FILE    = 
       
   202 #---------------------------------------------------------------------------
       
   203 # configuration options related to the man page output
       
   204 #---------------------------------------------------------------------------
       
   205 GENERATE_MAN           = NO
       
   206 MAN_OUTPUT             = man
       
   207 MAN_EXTENSION          = .3
       
   208 MAN_LINKS              = NO
       
   209 #---------------------------------------------------------------------------
       
   210 # configuration options related to the XML output
       
   211 #---------------------------------------------------------------------------
       
   212 GENERATE_XML           = NO
       
   213 XML_OUTPUT             = xml
       
   214 XML_SCHEMA             = 
       
   215 XML_DTD                = 
       
   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        = YES
       
   233 EXPAND_ONLY_PREDEF     = YES
       
   234 SEARCH_INCLUDES        = YES
       
   235 INCLUDE_PATH           = 
       
   236 INCLUDE_FILE_PATTERNS  = 
       
   237 PREDEFINED             = "NONSHARABLE_CLASS(name)=class name" \
       
   238                          "_LIT(name,string)=const static TLitC<sizeof(L##string)/2> name={sizeof(L##string)/2-1,L##string}"
       
   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 HIDE_UNDOC_RELATIONS   = YES
       
   254 HAVE_DOT               = NO
       
   255 CLASS_GRAPH            = YES
       
   256 COLLABORATION_GRAPH    = NO
       
   257 GROUP_GRAPHS           = YES
       
   258 UML_LOOK               = YES
       
   259 TEMPLATE_RELATIONS     = NO
       
   260 INCLUDE_GRAPH          = YES
       
   261 INCLUDED_BY_GRAPH      = YES
       
   262 CALL_GRAPH             = NO
       
   263 CALLER_GRAPH           = NO
       
   264 GRAPHICAL_HIERARCHY    = YES
       
   265 DIRECTORY_GRAPH        = YES
       
   266 DOT_IMAGE_FORMAT       = png
       
   267 DOT_PATH               = 
       
   268 DOTFILE_DIRS           = 
       
   269 MAX_DOT_GRAPH_WIDTH    = 1024
       
   270 MAX_DOT_GRAPH_HEIGHT   = 1024
       
   271 MAX_DOT_GRAPH_DEPTH    = 0
       
   272 DOT_TRANSPARENT        = NO
       
   273 DOT_MULTI_TARGETS      = NO
       
   274 GENERATE_LEGEND        = YES
       
   275 DOT_CLEANUP            = YES
       
   276 #---------------------------------------------------------------------------
       
   277 # Configuration::additions related to the search engine   
       
   278 #---------------------------------------------------------------------------
       
   279 SEARCHENGINE           = NO