contentmgmt/contentaccessfwfordrm/engineering/dox/Doxyfile.cfg
changeset 108 ca9a0fc2f082
parent 102 deec7e509f66
equal deleted inserted replaced
102:deec7e509f66 108:ca9a0fc2f082
     1 # Doxyfile 1.4.6
       
     2 
       
     3 #---------------------------------------------------------------------------
       
     4 # Project related configuration options
       
     5 #---------------------------------------------------------------------------
       
     6 PROJECT_NAME           = "Content Access Framework"
       
     7 PROJECT_NUMBER         = 
       
     8 OUTPUT_DIRECTORY       = ./output
       
     9 CREATE_SUBDIRS         = NO
       
    10 OUTPUT_LANGUAGE        = English
       
    11 USE_WINDOWS_ENCODING   = YES
       
    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                = "publishedAll=@par Interface: publishedAll\n" \
       
    28                          "publishedPartner=@par Interface: publishedPartner\n" \
       
    29                          "internalAll=@par Interface: internalAll\n" \
       
    30                          "internalComponent=@par Interface: internalComponent\n" \
       
    31                          "internalTechnology=@par Interface: internalTechnology\n" \
       
    32                          "prototype=@par Interface: prototype\n" \
       
    33                          "interim=@par Interface: interim\n" \
       
    34                          "released=@par Interface: released\n" \
       
    35                          "deprecated=@par Interface: deprecated\n" \
       
    36                          "removed=@par Interface: removed\n" \
       
    37                          "capability=@par Capability: \n" \
       
    38                          "leave=@par Leave: \n" \
       
    39                          "panic=@par Panic: \n" \
       
    40                          "SYMPurpose=@par File Purpose: \n"
       
    41 OPTIMIZE_OUTPUT_FOR_C  = NO
       
    42 OPTIMIZE_OUTPUT_JAVA   = NO
       
    43 BUILTIN_STL_SUPPORT    = NO
       
    44 DISTRIBUTE_GROUP_DOC   = NO
       
    45 SUBGROUPING            = YES
       
    46 #---------------------------------------------------------------------------
       
    47 # Build related configuration options
       
    48 #---------------------------------------------------------------------------
       
    49 EXTRACT_ALL            = YES
       
    50 EXTRACT_PRIVATE        = NO
       
    51 EXTRACT_STATIC         = YES
       
    52 EXTRACT_LOCAL_CLASSES  = NO
       
    53 EXTRACT_LOCAL_METHODS  = NO
       
    54 HIDE_UNDOC_MEMBERS     = NO
       
    55 HIDE_UNDOC_CLASSES     = NO
       
    56 HIDE_FRIEND_COMPOUNDS  = NO
       
    57 HIDE_IN_BODY_DOCS      = YES
       
    58 INTERNAL_DOCS          = NO
       
    59 CASE_SENSE_NAMES       = YES
       
    60 HIDE_SCOPE_NAMES       = NO
       
    61 SHOW_INCLUDE_FILES     = YES
       
    62 INLINE_INFO            = YES
       
    63 SORT_MEMBER_DOCS       = YES
       
    64 SORT_BRIEF_DOCS        = NO
       
    65 SORT_BY_SCOPE_NAME     = NO
       
    66 GENERATE_TODOLIST      = NO
       
    67 GENERATE_TESTLIST      = NO
       
    68 GENERATE_BUGLIST       = NO
       
    69 GENERATE_DEPRECATEDLIST= YES
       
    70 ENABLED_SECTIONS       = 
       
    71 MAX_INITIALIZER_LINES  = 30
       
    72 SHOW_USED_FILES        = YES
       
    73 SHOW_DIRECTORIES       = NO
       
    74 FILE_VERSION_FILTER    = 
       
    75 #---------------------------------------------------------------------------
       
    76 # configuration options related to warning and progress messages
       
    77 #---------------------------------------------------------------------------
       
    78 QUIET                  = NO
       
    79 WARNINGS               = YES
       
    80 WARN_IF_UNDOCUMENTED   = YES
       
    81 WARN_IF_DOC_ERROR      = YES
       
    82 WARN_NO_PARAMDOC       = NO
       
    83 WARN_FORMAT            = "$file:$line: $text"
       
    84 WARN_LOGFILE           = 
       
    85 #---------------------------------------------------------------------------
       
    86 # configuration options related to the input files
       
    87 #---------------------------------------------------------------------------
       
    88 INPUT                  = ../../inc \
       
    89                          ./cafmainpage.dox \
       
    90                          ./CAFIntroduction.dox \
       
    91                          ./Architecture.dox \
       
    92                          ./HowToContentAPI.dox \
       
    93                          ./NavigatingArchiveFiles.dox \
       
    94                          ./Attributes.dox \
       
    95                          ./HowToSupplierAPI.dox \
       
    96                          ./HowToManageFiles.dox \
       
    97                          ./HowToManageAgents.dox \
       
    98                          ./RightsManagerAPI.dox \
       
    99                          ./CAFCorruptData.dox \
       
   100                          ./UI.dox \
       
   101                          ./CafRecognizer.dox \
       
   102                          ./HowToAgentConfiguration.dox \
       
   103                          ./BackupAndRestoreOfAgentData.dox \
       
   104                          ./Examples.dox \
       
   105                          ./AsyncSendReceive.dox \
       
   106                          ./licensees.dox \
       
   107                          ./ReleaseNotes.dox
       
   108 FILE_PATTERNS          = *.cpp \
       
   109                          *.h \
       
   110                          *.inl \
       
   111                          *.hrh \
       
   112                          *.rss
       
   113 RECURSIVE              = YES
       
   114 EXCLUDE                = 
       
   115 EXCLUDE_SYMLINKS       = NO
       
   116 EXCLUDE_PATTERNS       = *.policy
       
   117 EXAMPLE_PATH           = 
       
   118 EXAMPLE_PATTERNS       = 
       
   119 EXAMPLE_RECURSIVE      = NO
       
   120 IMAGE_PATH             = .
       
   121 INPUT_FILTER           = 
       
   122 FILTER_PATTERNS        = 
       
   123 FILTER_SOURCE_FILES    = NO
       
   124 #---------------------------------------------------------------------------
       
   125 # configuration options related to source browsing
       
   126 #---------------------------------------------------------------------------
       
   127 SOURCE_BROWSER         = NO
       
   128 INLINE_SOURCES         = NO
       
   129 STRIP_CODE_COMMENTS    = YES
       
   130 REFERENCED_BY_RELATION = YES
       
   131 REFERENCES_RELATION    = YES
       
   132 USE_HTAGS              = NO
       
   133 VERBATIM_HEADERS       = YES
       
   134 #---------------------------------------------------------------------------
       
   135 # configuration options related to the alphabetical class index
       
   136 #---------------------------------------------------------------------------
       
   137 ALPHABETICAL_INDEX     = NO
       
   138 COLS_IN_ALPHA_INDEX    = 5
       
   139 IGNORE_PREFIX          = 
       
   140 #---------------------------------------------------------------------------
       
   141 # configuration options related to the HTML output
       
   142 #---------------------------------------------------------------------------
       
   143 GENERATE_HTML          = YES
       
   144 HTML_OUTPUT            = html
       
   145 HTML_FILE_EXTENSION    = .html
       
   146 HTML_HEADER            = 
       
   147 HTML_FOOTER            = 
       
   148 HTML_STYLESHEET        = 
       
   149 HTML_ALIGN_MEMBERS     = YES
       
   150 GENERATE_HTMLHELP      = YES
       
   151 CHM_FILE               = ../../../../engineering/CAF_Documentation.chm
       
   152 HHC_LOCATION           = "C:/Program Files/HTML Help Workshop/hhc.exe"
       
   153 GENERATE_CHI           = NO
       
   154 BINARY_TOC             = NO
       
   155 TOC_EXPAND             = NO
       
   156 DISABLE_INDEX          = NO
       
   157 ENUM_VALUES_PER_LINE   = 2
       
   158 GENERATE_TREEVIEW      = NO
       
   159 TREEVIEW_WIDTH         = 250
       
   160 #---------------------------------------------------------------------------
       
   161 # configuration options related to the LaTeX output
       
   162 #---------------------------------------------------------------------------
       
   163 GENERATE_LATEX         = NO
       
   164 LATEX_OUTPUT           = latex
       
   165 LATEX_CMD_NAME         = latex
       
   166 MAKEINDEX_CMD_NAME     = makeindex
       
   167 COMPACT_LATEX          = NO
       
   168 PAPER_TYPE             = a4wide
       
   169 EXTRA_PACKAGES         = 
       
   170 LATEX_HEADER           = 
       
   171 PDF_HYPERLINKS         = NO
       
   172 USE_PDFLATEX           = NO
       
   173 LATEX_BATCHMODE        = NO
       
   174 LATEX_HIDE_INDICES     = NO
       
   175 #---------------------------------------------------------------------------
       
   176 # configuration options related to the RTF output
       
   177 #---------------------------------------------------------------------------
       
   178 GENERATE_RTF           = NO
       
   179 RTF_OUTPUT             = rtf
       
   180 COMPACT_RTF            = NO
       
   181 RTF_HYPERLINKS         = NO
       
   182 RTF_STYLESHEET_FILE    = 
       
   183 RTF_EXTENSIONS_FILE    = 
       
   184 #---------------------------------------------------------------------------
       
   185 # configuration options related to the man page output
       
   186 #---------------------------------------------------------------------------
       
   187 GENERATE_MAN           = NO
       
   188 MAN_OUTPUT             = man
       
   189 MAN_EXTENSION          = .3
       
   190 MAN_LINKS              = NO
       
   191 #---------------------------------------------------------------------------
       
   192 # configuration options related to the XML output
       
   193 #---------------------------------------------------------------------------
       
   194 GENERATE_XML           = NO
       
   195 XML_OUTPUT             = xml
       
   196 XML_SCHEMA             = 
       
   197 XML_DTD                = 
       
   198 XML_PROGRAMLISTING     = YES
       
   199 #---------------------------------------------------------------------------
       
   200 # configuration options for the AutoGen Definitions output
       
   201 #---------------------------------------------------------------------------
       
   202 GENERATE_AUTOGEN_DEF   = NO
       
   203 #---------------------------------------------------------------------------
       
   204 # configuration options related to the Perl module output
       
   205 #---------------------------------------------------------------------------
       
   206 GENERATE_PERLMOD       = NO
       
   207 PERLMOD_LATEX          = NO
       
   208 PERLMOD_PRETTY         = YES
       
   209 PERLMOD_MAKEVAR_PREFIX = 
       
   210 #---------------------------------------------------------------------------
       
   211 # Configuration options related to the preprocessor   
       
   212 #---------------------------------------------------------------------------
       
   213 ENABLE_PREPROCESSING   = YES
       
   214 MACRO_EXPANSION        = YES
       
   215 EXPAND_ONLY_PREDEF     = YES
       
   216 SEARCH_INCLUDES        = YES
       
   217 INCLUDE_PATH           = 
       
   218 INCLUDE_FILE_PATTERNS  = 
       
   219 PREDEFINED             = EXPORT_C \
       
   220                          REMOVE_CAF1 \
       
   221                          "NONSHARABLE_CLASS(name)=class name"
       
   222 EXPAND_AS_DEFINED      = 
       
   223 SKIP_FUNCTION_MACROS   = NO
       
   224 #---------------------------------------------------------------------------
       
   225 # Configuration::additions related to external references   
       
   226 #---------------------------------------------------------------------------
       
   227 TAGFILES               = 
       
   228 GENERATE_TAGFILE       = 
       
   229 ALLEXTERNALS           = NO
       
   230 EXTERNAL_GROUPS        = YES
       
   231 PERL_PATH              = /usr/bin/perl
       
   232 #---------------------------------------------------------------------------
       
   233 # Configuration options related to the dot tool   
       
   234 #---------------------------------------------------------------------------
       
   235 CLASS_DIAGRAMS         = YES
       
   236 HIDE_UNDOC_RELATIONS   = YES
       
   237 HAVE_DOT               = YES
       
   238 CLASS_GRAPH            = YES
       
   239 COLLABORATION_GRAPH    = YES
       
   240 GROUP_GRAPHS           = YES
       
   241 UML_LOOK               = NO
       
   242 TEMPLATE_RELATIONS     = YES
       
   243 INCLUDE_GRAPH          = YES
       
   244 INCLUDED_BY_GRAPH      = YES
       
   245 CALL_GRAPH             = NO
       
   246 GRAPHICAL_HIERARCHY    = YES
       
   247 DIRECTORY_GRAPH        = YES
       
   248 DOT_IMAGE_FORMAT       = png
       
   249 DOT_PATH               = 
       
   250 DOTFILE_DIRS           = 
       
   251 MAX_DOT_GRAPH_WIDTH    = 1024
       
   252 MAX_DOT_GRAPH_HEIGHT   = 1024
       
   253 MAX_DOT_GRAPH_DEPTH    = 0
       
   254 DOT_TRANSPARENT        = NO
       
   255 DOT_MULTI_TARGETS      = NO
       
   256 GENERATE_LEGEND        = YES
       
   257 DOT_CLEANUP            = YES
       
   258 #---------------------------------------------------------------------------
       
   259 # Configuration::additions related to the search engine   
       
   260 #---------------------------------------------------------------------------
       
   261 SEARCHENGINE           = NO