changeset 5854:2c00c51357d8

added more content to graal.api.meta overview
author Doug Simon <doug.simon@oracle.com>
date Wed, 18 Jul 2012 14:38:16 +0200
parents 767312416f6a
children 0278da961319
files graal/com.oracle.graal.api.meta/overview.html graal/overview.html mxtool/mx.py
diffstat 3 files changed, 8 insertions(+), 3 deletions(-) [+]
line wrap: on
line diff
--- a/graal/com.oracle.graal.api.meta/overview.html	Wed Jul 18 12:17:38 2012 +0200
+++ b/graal/com.oracle.graal.api.meta/overview.html	Wed Jul 18 14:38:16 2012 +0200
@@ -30,7 +30,8 @@
 </head>
 <body>
 
-Documentation for the <code>com.oracle.graal.api.meta</code> project.
+The <code>com.oracle.graal.api.meta</code> project provides an API to the runtime data structures
+for various Java elements. It extends standard Java reflection in terms of the amount detail exposed.
 
 </body>
 </html>
--- a/graal/overview.html	Wed Jul 18 12:17:38 2012 +0200
+++ b/graal/overview.html	Wed Jul 18 14:38:16 2012 +0200
@@ -30,7 +30,7 @@
 </head>
 <body>
 
-<a href="modules.svg" title="Click to enlarge"><img src="modules.jpg" width="400"/></a>
+<a href="modules.html" title="Click to enlarge"><img src="modules.jpg" width="400"/></a>
 <p>
 This document is the unified Javadoc for the Graal code base.
 The module dependency graph is shown above.
--- a/mxtool/mx.py	Wed Jul 18 12:17:38 2012 +0200
+++ b/mxtool/mx.py	Wed Jul 18 14:38:16 2012 +0200
@@ -2249,6 +2249,7 @@
             dot = join(tmpbase, 'all', str(args.dot_output_base) + '.dot')
             svg = join(tmpbase, 'all', str(args.dot_output_base) + '.svg')
             jpg = join(tmpbase, 'all', str(args.dot_output_base) + '.jpg')
+            html = join(tmpbase, 'all', str(args.dot_output_base) + '.html')
             with open(dot, 'w') as fp:
                 dim = len(projects)
                 print >> fp, 'digraph projects {'
@@ -2278,8 +2279,11 @@
         with open(svg, 'w') as fp:
             fp.write(content)
 
+        # Create HTML that embeds the svg file in an <object> frame
+        with open(html, 'w') as fp:
+            print >> fp, '<html><body><object data="modules.svg" type="image/svg+xml"></object></body></html>'
+
         # Post-process generated overview-summary.html files
-
         def fix_overview_summary(path, topLink):
             """
             Processes an "overview-summary.html" generated by javadoc to put the complete