Mercurial > hg > graal-jvmci-8
changeset 5782:488864d5069a
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 | 039b73517e49 |
children | 0017be5ba31e |
files | mx/commands.py mxtool/mx.py |
diffstat | 2 files changed, 13 insertions(+), 2 deletions(-) [+] |
line wrap: on
line diff
--- a/mx/commands.py Fri Jul 06 15:11:02 2012 +0200 +++ b/mx/commands.py Fri Jul 06 15:31:48 2012 +0200 @@ -973,6 +973,11 @@ """creates a website containing javadoc and the project dependency graph""" return mx.site(['--name', 'Graal', + '--jd', '@-tag', '--jd', '@test:X', + '--jd', '@-tag', '--jd', '@run:X', + '--jd', '@-tag', '--jd', '@bug:X', + '--jd', '@-tag', '--jd', '@summary:X', + '--jd', '@-tag', '--jd', '@vmoption:X', '--overview', join(_graal_home, 'graal', 'overview.html'), '--title', 'Graal OpenJDK Project Documentation', '--dot-output-base', 'modules'] + args)
--- a/mxtool/mx.py Fri Jul 06 15:11:02 2012 +0200 +++ b/mxtool/mx.py Fri Jul 06 15:31:48 2012 +0200 @@ -2153,6 +2153,7 @@ parser.add_argument('--name', action='store', help='name of overall documentation', required=True, metavar='<name>') parser.add_argument('--overview', action='store', help='path to the overview content for overall documentation', required=True, metavar='<path>') parser.add_argument('--projects', action='store', help='comma separated projects to process (omit to process all projects)') + parser.add_argument('--jd', action='append', help='extra Javadoc arguments (e.g. --jd @-use)', metavar='@<arg>', default=[]) parser.add_argument('--exclude-packages', action='store', help='comma separated packages to exclude', metavar='<pkgs>') 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>') parser.add_argument('--title', action='store', help='value used for -windowtitle and -doctitle javadoc args for overall documentation (default: "<name>")', metavar='<title>') @@ -2172,9 +2173,14 @@ projects_arg = ['--projects', args.projects] projects = [project(name) for name in args.projects.split(',')] + extra_javadoc_args = [] + for a in args.jd: + extra_javadoc_args.append('--arg') + extra_javadoc_args.append('@' + a) + try: # Create javadoc for each project - javadoc(['--base', tmpbase] + exclude_packages_arg + projects_arg) + javadoc(['--base', tmpbase] + exclude_packages_arg + projects_arg + extra_javadoc_args) # Create unified javadoc for all projects title = args.title if args.title is not None else args.name @@ -2182,7 +2188,7 @@ '--unified', '--arg', '@-windowtitle', '--arg', '@' + title, '--arg', '@-doctitle', '--arg', '@' + title, - '--arg', '@-overview', '--arg', '@' + args.overview] + exclude_packages_arg + projects_arg) + '--arg', '@-overview', '--arg', '@' + args.overview] + exclude_packages_arg + projects_arg + extra_javadoc_args) os.rename(join(tmpbase, 'javadoc'), unified) # Generate dependency graph with Graphviz