summaryrefslogtreecommitdiff
path: root/gtkdoc-scan.in
blob: 7893ebc15690a4ffed9bc0e3d5e6d4f13c0cb7b4 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
#!@PYTHON@
# -*- python -*-
#
# gtk-doc - GTK DocBook documentation generator.
# Copyright (C) 1998  Damon Chaplin
#               2007-2016  Stefan Sauer
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 2 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
#

from __future__ import print_function

import argparse
import sys

try:
  import gtkdoc_uninstalled
except ModuleNotFoundError:
  sys.path.append('@PYTHON_PACKAGE_DIR@')

from gtkdoc import common, config, scan

if __name__ == '__main__':
    parser = argparse.ArgumentParser(
        description='gtkdoc-scan version %s - scan header files for public symbols' % config.version)
    parser.add_argument('--version', action='version', version=config.version)
    parser.add_argument('--module', required=True,
                        help='Name of the doc module being processed.')
    parser.add_argument('--source-dir', action='append', default=[],
                        help='Directories containing the source files to scan')
    parser.add_argument('--ignore-headers', default='',
                        help='A space-separated list of header files/dirs not to scan')
    parser.add_argument('--output-dir', default='.',
                        help='The directory where the results are stored')
    parser.add_argument('--deprecated-guards', default='does_not_match_any_cpp_symbols_at_all_nope',
                        help='A |-separated list of symbols used as deprecation guards')
    parser.add_argument('--ignore-decorators', default='(?=no)match',
                        help='A |-separated list of additional decorators in'
                        'declarations that should be ignored')
    parser.add_argument('--rebuild-sections', action='store_true', default=False,
                        help='Rebuild (overwrite) the MODULE-sections.txt file')
    parser.add_argument('--rebuild-types', action='store_true', default=False,
                        help='Automatically recreate the MODULE.types file using'
                        'all the *_get_type() functions found')
    parser.add_argument('headers', nargs='*')

    options = parser.parse_args()

    common.setup_logging()

    scan.Run(options)