doc/api/doxy-api.conf

   1 # BSD LICENSE
   2 #
   3 # Copyright 2013 6WIND S.A.
   4 #
   5 # Redistribution and use in source and binary forms, with or without
   6 # modification, are permitted provided that the following conditions
   7 # are met:
   8 #
   9 #   * Redistributions of source code must retain the above copyright
  10 #     notice, this list of conditions and the following disclaimer.
  11 #   * Redistributions in binary form must reproduce the above copyright
  12 #     notice, this list of conditions and the following disclaimer in
  13 #     the documentation and/or other materials provided with the
  14 #     distribution.
  15 #   * Neither the name of 6WIND S.A. nor the names of its
  16 #     contributors may be used to endorse or promote products derived
  17 #     from this software without specific prior written permission.
  18 #
  19 # THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  20 # "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  21 # LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  22 # A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  23 # OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  24 # SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  25 # LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  26 # DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  27 # THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  28 # (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  29 # OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  30
  31 PROJECT_NAME            = DPDK
  32 INPUT                   = doc/api/doxy-api-index.md \
  33                           doc/api/examples.dox \
  34                           drivers/net/bonding \
  35                           lib/librte_eal/common/include \
  36                           lib/librte_eal/common/include/generic \
  37                           lib/librte_acl \
  38                           lib/librte_cfgfile \
  39                           lib/librte_cmdline \
  40                           lib/librte_compat \
  41                           lib/librte_cryptodev \
  42                           lib/librte_distributor \
  43                           lib/librte_ether \
  44                           lib/librte_hash \
  45                           lib/librte_ip_frag \
  46                           lib/librte_ivshmem \
  47                           lib/librte_jobstats \
  48                           lib/librte_kni \
  49                           lib/librte_kvargs \
  50                           lib/librte_lpm \
  51                           lib/librte_mbuf \
  52                           lib/librte_mempool \
  53                           lib/librte_meter \
  54                           lib/librte_net \
  55                           lib/librte_pipeline \
  56                           lib/librte_port \
  57                           lib/librte_power \
  58                           lib/librte_reorder \
  59                           lib/librte_ring \
  60                           lib/librte_sched \
  61                           lib/librte_table \
  62                           lib/librte_timer \
  63                           lib/librte_vhost
  64 FILE_PATTERNS           = rte_*.h \
  65                           cmdline.h
  66 PREDEFINED              = __DOXYGEN__ \
  67                           __attribute__(x)=
  68
  69 OPTIMIZE_OUTPUT_FOR_C   = YES
  70 ENABLE_PREPROCESSING    = YES
  71 MACRO_EXPANSION         = YES
  72 EXPAND_ONLY_PREDEF      = YES
  73 EXTRACT_STATIC          = YES
  74 DISTRIBUTE_GROUP_DOC    = YES
  75 HIDE_UNDOC_MEMBERS      = YES
  76 HIDE_UNDOC_CLASSES      = YES
  77 HIDE_SCOPE_NAMES        = YES
  78 GENERATE_DEPRECATEDLIST = NO
  79 VERBATIM_HEADERS        = NO
  80 ALPHABETICAL_INDEX      = NO
  81
  82 HTML_TIMESTAMP          = NO
  83 HTML_DYNAMIC_SECTIONS   = YES
  84 SEARCHENGINE            = NO
  85 SORT_MEMBER_DOCS        = NO
  86 SOURCE_BROWSER          = YES
  87
  88 EXAMPLE_PATH            = examples
  89 EXAMPLE_PATTERNS        = *.c
  90 EXAMPLE_RECURSIVE       = YES