t83x/kernel/drivers/gpu/arm/midgard/docs/Doxyfile

   1 #
   2 # (C) COPYRIGHT 2011-2013, 2015 ARM Limited. All rights reserved.
   3 #
   4 # This program is free software and is provided to you under the terms of the
   5 # GNU General Public License version 2 as published by the Free Software
   6 # Foundation, and any use by you of this program is subject to the terms
   7 # of such GNU licence.
   8 #
   9 # A copy of the licence is included with the program, and can also be obtained
  10 # from Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
  11 # Boston, MA  02110-1301, USA.
  12 #
  13 #
  14
  15
  16
  17 ##############################################################################
  18
  19 # This file contains per-module Doxygen configuration. Please do not add
  20 # extra settings to this file without consulting all stakeholders, as they
  21 # may cause override project-wide settings.
  22 #
  23 # Additionally, when defining aliases, macros, sections etc, use the module
  24 # name as a prefix e.g. gles_my_alias.
  25
  26 ##############################################################################
  27
  28 @INCLUDE = ../../bldsys/Doxyfile_common
  29
  30 # The INPUT tag can be used to specify the files and/or directories that contain
  31 # documented source files. You may enter file names like "myfile.cpp" or
  32 # directories like "/usr/src/myproject". Separate the files or directories
  33 # with spaces.
  34
  35 INPUT                  += ../../kernel/drivers/gpu/arm/midgard/
  36
  37 ##############################################################################
  38 # Everything below here is optional, and in most cases not required
  39 ##############################################################################
  40
  41 # This tag can be used to specify a number of aliases that acts
  42 # as commands in the documentation. An alias has the form "name=value".
  43 # For example adding "sideeffect=\par Side Effects:\n" will allow you to
  44 # put the command \sideeffect (or @sideeffect) in the documentation, which
  45 # will result in a user-defined paragraph with heading "Side Effects:".
  46 # You can put \n's in the value part of an alias to insert newlines.
  47
  48 ALIASES                +=
  49
  50 # The ENABLED_SECTIONS tag can be used to enable conditional
  51 # documentation sections, marked by \if sectionname ... \endif.
  52
  53 ENABLED_SECTIONS       +=
  54
  55 # If the value of the INPUT tag contains directories, you can use the
  56 # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
  57 # and *.h) to filter out the source-files in the directories. If left
  58 # blank the following patterns are tested:
  59 # *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx
  60 # *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py *.f90
  61
  62 FILE_PATTERNS          +=
  63
  64 # The EXCLUDE tag can be used to specify files and/or directories that should
  65 # excluded from the INPUT source files. This way you can easily exclude a
  66 # subdirectory from a directory tree whose root is specified with the INPUT tag.
  67 EXCLUDE                += ../../kernel/drivers/gpu/arm/midgard/platform ../../kernel/drivers/gpu/arm/midgard/platform_dummy ../../kernel/drivers/gpu/arm/midgard/scripts ../../kernel/drivers/gpu/arm/midgard/tests ../../kernel/drivers/gpu/arm/midgard/Makefile ../../kernel/drivers/gpu/arm/midgard/Makefile.kbase ../../kernel/drivers/gpu/arm/midgard/Kbuild ../../kernel/drivers/gpu/arm/midgard/Kconfig ../../kernel/drivers/gpu/arm/midgard/sconscript ../../kernel/drivers/gpu/arm/midgard/docs ../../kernel/drivers/gpu/arm/midgard/pm_test_script.sh ../../kernel/drivers/gpu/arm/midgard/mali_uk.h ../../kernel/drivers/gpu/arm/midgard/Makefile
  68
  69
  70 # If the value of the INPUT tag contains directories, you can use the
  71 # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
  72 # certain files from those directories. Note that the wildcards are matched
  73 # against the file with absolute path, so to exclude all test directories
  74 # for example use the pattern */test/*
  75
  76 EXCLUDE_PATTERNS       +=
  77
  78 # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
  79 # (namespaces, classes, functions, etc.) that should be excluded from the
  80 # output. The symbol name can be a fully qualified name, a word, or if the
  81 # wildcard * is used, a substring. Examples: ANamespace, AClass,
  82 # AClass::ANamespace, ANamespace::*Test
  83
  84 EXCLUDE_SYMBOLS        +=
  85
  86 # The EXAMPLE_PATH tag can be used to specify one or more files or
  87 # directories that contain example code fragments that are included (see
  88 # the \include command).
  89
  90 EXAMPLE_PATH           +=
  91
  92 # The IMAGE_PATH tag can be used to specify one or more files or
  93 # directories that contain image that are included in the documentation (see
  94 # the \image command).
  95
  96 IMAGE_PATH             +=
  97
  98 # The INCLUDE_PATH tag can be used to specify one or more directories that
  99 # contain include files that are not input files but should be processed by
 100 # the preprocessor.
 101
 102 INCLUDE_PATH           +=
 103
 104 # The PREDEFINED tag can be used to specify one or more macro names that
 105 # are defined before the preprocessor is started (similar to the -D option of
 106 # gcc). The argument of the tag is a list of macros of the form: name
 107 # or name=definition (no spaces). If the definition and the = are
 108 # omitted =1 is assumed. To prevent a macro definition from being
 109 # undefined via #undef or recursively expanded use the := operator
 110 # instead of the = operator.
 111
 112 PREDEFINED             +=
 113
 114 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
 115 # this tag can be used to specify a list of macro names that should be expanded.
 116 # The macro definition that is found in the sources will be used.
 117 # Use the PREDEFINED tag if you want to use a different macro definition.
 118
 119 EXPAND_AS_DEFINED      +=
 120
 121 # The DOTFILE_DIRS tag can be used to specify one or more directories that
 122 # contain dot files that are included in the documentation (see the
 123 # \dotfile command).
 124
 125 DOTFILE_DIRS           += ../../kernel/drivers/gpu/arm/midgard/docs
 126