Mercurial > hg > truffle

comparison mxtool/mx.py @ 5782:488864d5069a

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
added support for passing -tag option to javadoc to suppress warnings about unrecognized tags in javadoc comments used above support to suppress warnings about testing related tags (e.g., @test, @bug etc)
author Doug Simon <doug.simon@oracle.com>
date Fri, 06 Jul 2012 15:31:48 +0200
parents 74c802348d1f
children 0cd337450409
comparison
equal deleted inserted replaced
5781:039b73517e49 5782:488864d5069a
2151 parser = ArgumentParser(prog='site') 2151 parser = ArgumentParser(prog='site')
2152 parser.add_argument('-d', '--base', action='store', help='directory for generated site', required=True, metavar='<dir>') 2152 parser.add_argument('-d', '--base', action='store', help='directory for generated site', required=True, metavar='<dir>')
2153 parser.add_argument('--name', action='store', help='name of overall documentation', required=True, metavar='<name>') 2153 parser.add_argument('--name', action='store', help='name of overall documentation', required=True, metavar='<name>')
2154 parser.add_argument('--overview', action='store', help='path to the overview content for overall documentation', required=True, metavar='<path>') 2154 parser.add_argument('--overview', action='store', help='path to the overview content for overall documentation', required=True, metavar='<path>')
2155 parser.add_argument('--projects', action='store', help='comma separated projects to process (omit to process all projects)') 2155 parser.add_argument('--projects', action='store', help='comma separated projects to process (omit to process all projects)')
2156 parser.add_argument('--jd', action='append', help='extra Javadoc arguments (e.g. --jd @-use)', metavar='@<arg>', default=[])
2156 parser.add_argument('--exclude-packages', action='store', help='comma separated packages to exclude', metavar='<pkgs>') 2157 parser.add_argument('--exclude-packages', action='store', help='comma separated packages to exclude', metavar='<pkgs>')
2157 parser.add_argument('--dot-output-base', action='store', help='base file name (relative to <dir>/all) for project dependency graph .svg and .jpg files generated by dot (omit to disable dot generation)', metavar='<path>') 2158 parser.add_argument('--dot-output-base', action='store', help='base file name (relative to <dir>/all) for project dependency graph .svg and .jpg files generated by dot (omit to disable dot generation)', metavar='<path>')
2158 parser.add_argument('--title', action='store', help='value used for -windowtitle and -doctitle javadoc args for overall documentation (default: "<name>")', metavar='<title>') 2159 parser.add_argument('--title', action='store', help='value used for -windowtitle and -doctitle javadoc args for overall documentation (default: "<name>")', metavar='<title>')
2159 args = parser.parse_args(args) 2160 args = parser.parse_args(args)
2160 2161
2170 projects_arg = [] 2171 projects_arg = []
2171 if args.projects is not None: 2172 if args.projects is not None:
2172 projects_arg = ['--projects', args.projects] 2173 projects_arg = ['--projects', args.projects]
2173 projects = [project(name) for name in args.projects.split(',')] 2174 projects = [project(name) for name in args.projects.split(',')]
2174 2175
2176 extra_javadoc_args = []
2177 for a in args.jd:
2178 extra_javadoc_args.append('--arg')
2179 extra_javadoc_args.append('@' + a)
2180
2175 try: 2181 try:
2176 # Create javadoc for each project 2182 # Create javadoc for each project
2177 javadoc(['--base', tmpbase] + exclude_packages_arg + projects_arg) 2183 javadoc(['--base', tmpbase] + exclude_packages_arg + projects_arg + extra_javadoc_args)
2178 2184
2179 # Create unified javadoc for all projects 2185 # Create unified javadoc for all projects
2180 title = args.title if args.title is not None else args.name 2186 title = args.title if args.title is not None else args.name
2181 javadoc(['--base', tmpbase, 2187 javadoc(['--base', tmpbase,
2182 '--unified', 2188 '--unified',
2183 '--arg', '@-windowtitle', '--arg', '@' + title, 2189 '--arg', '@-windowtitle', '--arg', '@' + title,
2184 '--arg', '@-doctitle', '--arg', '@' + title, 2190 '--arg', '@-doctitle', '--arg', '@' + title,
2185 '--arg', '@-overview', '--arg', '@' + args.overview] + exclude_packages_arg + projects_arg) 2191 '--arg', '@-overview', '--arg', '@' + args.overview] + exclude_packages_arg + projects_arg + extra_javadoc_args)
2186 os.rename(join(tmpbase, 'javadoc'), unified) 2192 os.rename(join(tmpbase, 'javadoc'), unified)
2187 2193
2188 # Generate dependency graph with Graphviz 2194 # Generate dependency graph with Graphviz
2189 if args.dot_output_base is not None: 2195 if args.dot_output_base is not None:
2190 dot = join(tmpbase, 'all', str(args.dot_output_base) + '.dot') 2196 dot = join(tmpbase, 'all', str(args.dot_output_base) + '.dot')