gtkdoc-scan.in

   1 #!@PYTHON@
   2 # -*- python -*-
   3 #
   4 # gtk-doc - GTK DocBook documentation generator.
   5 # Copyright (C) 1998  Damon Chaplin
   6 #               2007-2016  Stefan Sauer
   7 #
   8 # This program is free software; you can redistribute it and/or modify
   9 # it under the terms of the GNU General Public License as published by
  10 # the Free Software Foundation; either version 2 of the License, or
  11 # (at your option) any later version.
  12 #
  13 # This program is distributed in the hope that it will be useful,
  14 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  15 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16 # GNU General Public License for more details.
  17 #
  18 # You should have received a copy of the GNU General Public License
  19 # along with this program; if not, write to the Free Software
  20 # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  21 #
  22
  23 from __future__ import print_function
  24
  25 import argparse
  26 import sys
  27 sys.path.append('@PYTHON_PACKAGE_DIR@')
  28
  29 from gtkdoc import common, config, scan
  30
  31 if __name__ == '__main__':
  32     parser = argparse.ArgumentParser(
  33         description='gtkdoc-scan version %s - scan header files for public symbols' % config.version)
  34     parser.add_argument('--version', action='version', version=config.version)
  35     parser.add_argument('--module', required=True,
  36                         help='Name of the doc module being processed.')
  37     parser.add_argument('--source-dir', action='append', default=[],
  38                         help='Directories containing the source files to scan')
  39     parser.add_argument('--ignore-headers', default='',
  40                         help='A space-separated list of header files/dirs not to scan')
  41     parser.add_argument('--output-dir', default='.',
  42                         help='The directory where the results are stored')
  43     parser.add_argument('--deprecated-guards', default='does_not_match_any_cpp_symbols_at_all_nope',
  44                         help='A |-separated list of symbols used as deprecation guards')
  45     parser.add_argument('--ignore-decorators', default='(?=no)match',
  46                         help='A |-separated list of additional decorators in'
  47                         'declarations that should be ignored')
  48     parser.add_argument('--rebuild-sections', action='store_true', default=False,
  49                         help='Rebuild (overwrite) the MODULE-sections.txt file')
  50     parser.add_argument('--rebuild-types', action='store_true', default=False,
  51                         help='Automatically recreate the MODULE.types file using'
  52                         'all the *_get_type() functions found')
  53     parser.add_argument('headers', nargs='*')
  54
  55     options = parser.parse_args()
  56
  57     common.setup_logging()
  58
  59     scan.Run(options)