You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@harmony.apache.org by na...@apache.org on 2007/01/25 15:55:05 UTC
svn commit: r499808 - in /harmony/standard/site: docs/sitemap.html
docs/subcomponents/drlvm/DoxygenStart.html
docs/subcomponents/drlvm/index.html xdocs/sitemap.xml
xdocs/subcomponents/drlvm/DoxygenStart.xml
xdocs/subcomponents/drlvm/index.xml
Author: nadinem
Date: Thu Jan 25 06:55:03 2007
New Revision: 499808
URL: http://svn.apache.org/viewvc?view=rev&rev=499808
Log:
adding new page with links to DRLVM Doxygen reference materials (now the new file itself and several links to it)
Added:
harmony/standard/site/docs/subcomponents/drlvm/DoxygenStart.html
harmony/standard/site/xdocs/subcomponents/drlvm/DoxygenStart.xml
Modified:
harmony/standard/site/docs/sitemap.html
harmony/standard/site/docs/subcomponents/drlvm/index.html
harmony/standard/site/xdocs/sitemap.xml
harmony/standard/site/xdocs/subcomponents/drlvm/index.xml
Modified: harmony/standard/site/docs/sitemap.html
URL: http://svn.apache.org/viewvc/harmony/standard/site/docs/sitemap.html?view=diff&rev=499808&r1=499807&r2=499808
==============================================================================
--- harmony/standard/site/docs/sitemap.html (original)
+++ harmony/standard/site/docs/sitemap.html Thu Jan 25 06:55:03 2007
@@ -457,6 +457,10 @@
details on the PopFrame implementation as currently done in DRLVM, description of the functions
responsible for the operation and gives info on specifics of the current implementation
</p>
+ <p>
+ <a href="subcomponents/drlvm/DoxygenStart.html">DRLVM Source Code Generated Documentation Index</a> -
+ a landing page with links to autogenerated Doxygen documentation for DRLVM interface headers
+ </p>
<h2>
Added: harmony/standard/site/docs/subcomponents/drlvm/DoxygenStart.html
URL: http://svn.apache.org/viewvc/harmony/standard/site/docs/subcomponents/drlvm/DoxygenStart.html?view=auto&rev=499808
==============================================================================
--- harmony/standard/site/docs/subcomponents/drlvm/DoxygenStart.html (added)
+++ harmony/standard/site/docs/subcomponents/drlvm/DoxygenStart.html Thu Jan 25 06:55:03 2007
@@ -0,0 +1,307 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+
+<!--
+Licensed to the Apache Software Foundation (ASF) under one or more
+contributor license agreements. See the NOTICE file distributed with
+this work for additional information regarding copyright ownership.
+The ASF licenses this file to You under the Apache License, Version 2.0
+(the "License"); you may not use this file except in compliance with
+the License. You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+-->
+
+
+<!-- start the processing -->
+ <!-- ====================================================================== -->
+ <!-- GENERATED FILE, DO NOT EDIT, EDIT THE XML FILE IN xdocs INSTEAD! -->
+ <!-- Main Page Section -->
+ <!-- ====================================================================== -->
+ <html>
+ <head>
+ <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"/>
+
+ <meta name="author" value="Harmony Documentation Team">
+ <meta name="email" value="dev@harmony.apache.org">
+
+
+
+
+
+
+
+ <title>Apache Harmony - Apache Harmony DRL Virtual Machine Doc Index</title>
+
+
+
+ <link rel="stylesheet" type="text/css" href="../../site.css"/>
+ </head>
+
+ <body>
+ <table width="100%" cellspacing="0">
+ <!-- TOP IMAGE -->
+ <tr>
+ <td align='LEFT'>
+ <table><tr><td>
+ <td>
+<a href="http://harmony.apache.org/"><img src="../../images/harmony-logo-new.png" alt="Apache Harmony" /></a>
+</td>
+</td>
+ </td></tr></table>
+ </td>
+ <td align='RIGHT'>
+<!-- <a href="http://harmony.apache.org/">
+ <img src="http://harmony.apache.org/images/apache-incubator-logo.png"
+ alt="Apache Harmony" /></a>
+--> </td>
+ </tr>
+ </table>
+ <table width="100%" cellspacing="4">
+ <tr><td colspan="2">
+ <hr noshade="" size="1"/>
+ </td></tr>
+
+ <tr>
+ <!-- LEFT SIDE NAVIGATION -->
+ <td class="menuItem" width="20%" nowrap="true">
+
+ <!-- special ACon Logo - leave here for next time
+ <a href="http://www.us.apachecon.com/">
+ <img src="http://www.apache.org/ads/ApacheCon/240x120-2006-us.gif"
+ alt="ApacheCon US 2006" />
+ </a> -->
+
+ <!-- regular menu -->
+
+
+ <!-- ============================================================ -->
+
+ <p class="menuItem"><strong>General</strong></p>
+ <ul>
+ <li class="menuItem"> <a href="../../index.html">Home</a>
+</li>
+
+
+ <li class="menuItem"> <a href="../../license.html">License</a>
+</li>
+
+
+ <li class="menuItem"> <a href="http://apache.org">ASF</a>
+</li>
+
+
+ <li class="menuItem"> <a href="../../contribution_policy.html">Contribution Policy</a>
+</li>
+
+
+ <li class="menuItem"> <a href="../../downloads.html">Downloads</a>
+</li>
+
+
+ <li class="menuItem"> <a href="../../faq.html">FAQ</a>
+</li>
+
+
+
+ </ul>
+ <p class="menuItem"><strong>Community</strong></p>
+ <ul>
+ <li class="menuItem"> <a href="../../get-involved.html">Get Involved</a>
+</li>
+
+
+ <li class="menuItem"> <a href="../../contributors.html">Who we are</a>
+</li>
+
+
+ <li class="menuItem"> <a href="../../mailing.html">Mailing Lists</a>
+</li>
+
+
+ <li class="menuItem"> <a href="http://issues.apache.org/jira/browse/HARMONY">Bug Tracker</a>
+</li>
+
+
+ <li class="menuItem"> <a href="../../related.html">Other Projects</a>
+</li>
+
+
+
+ </ul>
+ <p class="menuItem"><strong>Development</strong></p>
+ <ul>
+ <li class="menuItem"> <a href="../../svn.html">Source Code</a>
+</li>
+
+
+ <li class="menuItem"> <a href="../../quickhelp_contributors.html">Getting Started</a>
+</li>
+
+
+ <li class="menuItem"> <a href="../../roadmap.html">Project Roadmap</a>
+</li>
+
+
+ <li class="menuItem"> <a href="../../issue_resolution_guideline.html">Resolution Guideline</a>
+</li>
+
+
+
+ </ul>
+ <p class="menuItem"><strong>Documentation</strong></p>
+ <ul>
+ <li class="menuItem"> <a href="../../sitemap.html">Sitemap</a>
+</li>
+
+
+ <li class="menuItem"> <a href="http://wiki.apache.org/harmony">Wiki</a>
+</li>
+
+
+ <li class="menuItem"> <a href="../../hdk.html">HDK</a>
+</li>
+
+
+ <li class="menuItem"> <a href="../../subcomponents/drlvm/index.html">DRLVM</a>
+</li>
+
+
+ <li class="menuItem"> <a href="../../subcomponents/classlibrary/index.html">Class Library</a>
+</li>
+
+
+ <li class="menuItem"> <a href="../../subcomponents/buildtest/index.html">Build-test Framework</a>
+</li>
+
+
+
+ </ul>
+ </td>
+ <td width="80%" valign="top"><a name="top"></a>
+ <h1>
+ <a name="DRLVM Source Code Generated Documentation Index">DRLVM Source Code Generated Documentation Index</a>
+ </h1>
+ <p>This is a landing page for Doxygen source code reference generated automatically from interface headers.
+Each link should lead to a documentation bundle generated from a component-related set of header files.
+The purpose of these documents is to provide a complete reference of available code in DRLVM interfaces.
+Because the code base is being actively developed, not all interfaces are well-documented at this point, so that
+you can find some interfaces not documented. Everyone's welcome to contribute to this initiative.
+</p>
+ <p>
+The documentation bundles were generated automatically and posted on the site server. You can regenerate the docs
+from your source files locally, as described in section <a href="#Regenerating the Reference">Regenerating the Reference</a>.
+</p>
+
+ <h2>
+ <a name="Doxygen API Reference for DRLVM Sources">Doxygen API Reference for DRLVM Sources</a>
+ </h2>
+
+ <p>This is a list of links to generated source code documentation bundles.
+ </p>
+ <ul>
+ <li><a href="intf/html/index.html">DRLVM Interfaces</a> - the high-level interface headers</li>
+ <li><a href="em/html/index.html">Execution Manager</a></li>
+ <li>Garbage Collectors:
+ <ul>
+ <li><a href="gc_cc/html/index.html">Copying/Compacting Garbage Collector</a></li>
+ <li><a href="gc_gen/html/index.html">Generational Garbage Collector</a></li>
+ <li><a href="gcv4/html/index.html">Obsolete v.4 Garbage Collector</a></li>
+ </ul></li>
+ <li><a href="interpreter/html/index.html">Interpreter</a></li>
+ <li><a href="jitrino/html/index.html">Jitrino</a>- the just-in-time compiler </li>
+ <li><a href="port/html/index.html">Porting Layer</a> - the extensions to APR</li>
+ <li><a href="thread/html/index.html">Thread Manager</a></li>
+ <li><a href="vmcore/html/index.html">VM Infrastructure</a> - the VM core component interfaces</li>
+ <li><a href="vmi/html/index.html">Class Library Support</a> - the VMI interface</li>
+ <li><a href="vmstart/html/index.html">Component Manager</a></li>
+ <li><a href="tests/html/index.html">DTLVM Tests</a></li>
+ <li><a href="drlvm/html/index.html">All DRLVM</a> - the big bundle with all of the above</li>
+ </ul>
+
+
+ <h2>
+ <a name="Other Useful DRLVM documents">Other Useful DRLVM documents</a>
+ </h2>
+
+ <ul>
+ <li><a href="index.html" target="_blank">DRLVM
+ website documentation page</a> with links to all DRLVM documents</li>
+ <li><a href="http://wiki.apache.org/harmony/DRLVM_Documentation_Quality">Status
+ metrics for Doxygen API reference</a>, Wiki page with metrics that show improvement metrics for the reference </li>
+ </ul>
+
+ <p><a href="#top">Back to top</a></p>
+ <h1>
+ <a name="Regenerating the Reference">Regenerating the Reference</a>
+ </h1>
+ <p>
+Follow these instructions to regenerate reference materials analogous to those posted on the website. You can also adjust
+the list of files to include into a specific documentation bundle and configure Doxygen to produce a different output,
+see section <a href="#Advanced Tasks">Advanced Tasks</a>
+</p>
+ <p>TBD</p>
+
+ <h2>
+ <a name="Advanced Tasks">Advanced Tasks</a>
+ </h2>
+
+ <p>
+Generation of Doxygen reference is adjusted by the following files located in <code>trunk/vm/doc</code>:
+</p>
+ <ul>
+<li><code>doc.properties</code> defines the input and output directories and the files included in each bundle
+</li>
+<li><code>build.xml</code> lists all doc build targets
+</li>
+<li><code>vm.cfg</code> is a copy of classlib configuration files and defines formatting and other output properties for Doxygen
+</li>
+
+</ul>
+
+ <p><a href="#top">Back to top</a></p>
+
+ </td>
+ </tr>
+
+ <!-- FOOTER -->
+ <tr><td colspan="2">
+ <hr noshade="" size="1"/>
+ </td></tr>
+ <tr><td colspan="2">
+ <div class="special"><em>
+ Copyright © 2003-2006, The Apache Software Foundation
+ </em></div>
+ </td></tr>
+ </table>
+ </body>
+ </html>
+<!-- end the processing -->
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Modified: harmony/standard/site/docs/subcomponents/drlvm/index.html
URL: http://svn.apache.org/viewvc/harmony/standard/site/docs/subcomponents/drlvm/index.html?view=diff&rev=499808&r1=499807&r2=499808
==============================================================================
--- harmony/standard/site/docs/subcomponents/drlvm/index.html (original)
+++ harmony/standard/site/docs/subcomponents/drlvm/index.html Thu Jan 25 06:55:03 2007
@@ -307,6 +307,8 @@
gives info on specifics of the current implementation.
</li>
</ul>
+ <li><a href="DoxygenStart.html">DRLVM Source Code Generated Documentation Index</a>
+ </li>
</ul>
Modified: harmony/standard/site/xdocs/sitemap.xml
URL: http://svn.apache.org/viewvc/harmony/standard/site/xdocs/sitemap.xml?view=diff&rev=499808&r1=499807&r2=499808
==============================================================================
--- harmony/standard/site/xdocs/sitemap.xml (original)
+++ harmony/standard/site/xdocs/sitemap.xml Thu Jan 25 06:55:03 2007
@@ -292,6 +292,10 @@
details on the PopFrame implementation as currently done in DRLVM, description of the functions
responsible for the operation and gives info on specifics of the current implementation
</p>
+ <p>
+ <a href="subcomponents/drlvm/DoxygenStart.html">DRLVM Source Code Generated Documentation Index</a> -
+ a landing page with links to autogenerated Doxygen documentation for DRLVM interface headers
+ </p>
</subsection>
<subsection name="Class Library">
Added: harmony/standard/site/xdocs/subcomponents/drlvm/DoxygenStart.xml
URL: http://svn.apache.org/viewvc/harmony/standard/site/xdocs/subcomponents/drlvm/DoxygenStart.xml?view=auto&rev=499808
==============================================================================
--- harmony/standard/site/xdocs/subcomponents/drlvm/DoxygenStart.xml (added)
+++ harmony/standard/site/xdocs/subcomponents/drlvm/DoxygenStart.xml Thu Jan 25 06:55:03 2007
@@ -0,0 +1,95 @@
+<?xml version="1.0" encoding="ISO-8859-1"?>
+ <!--
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements. See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You under the Apache License, Version 2.0
+ (the "License"); you may not use this file except in compliance with
+ the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+
+-->
+<document>
+
+ <properties>
+ <title>Apache Harmony DRL Virtual Machine Doc Index</title>
+ <author email="dev@harmony.apache.org">Harmony Documentation Team</author>
+ </properties>
+
+ <body>
+
+<section name="DRLVM Source Code Generated Documentation Index">
+<p>This is a landing page for Doxygen source code reference generated automatically from interface headers.
+Each link should lead to a documentation bundle generated from a component-related set of header files.
+The purpose of these documents is to provide a complete reference of available code in DRLVM interfaces.
+Because the code base is being actively developed, not all interfaces are well-documented at this point, so that
+you can find some interfaces not documented. Everyone's welcome to contribute to this initiative.
+</p>
+<p>
+The documentation bundles were generated automatically and posted on the site server. You can regenerate the docs
+from your source files locally, as described in section <a href="#Regenerating the Reference">Regenerating the Reference</a>.
+</p>
+ <subsection name="Doxygen API Reference for DRLVM Sources">
+ <p>This is a list of links to generated source code documentation bundles.
+ </p>
+ <ul>
+ <li><a href="intf/html/index.html">DRLVM Interfaces</a> - the high-level interface headers</li>
+ <li><a href="em/html/index.html">Execution Manager</a></li>
+ <li>Garbage Collectors:
+ <ul>
+ <li><a href="gc_cc/html/index.html">Copying/Compacting Garbage Collector</a></li>
+ <li><a href="gc_gen/html/index.html">Generational Garbage Collector</a></li>
+ <li><a href="gcv4/html/index.html">Obsolete v.4 Garbage Collector</a></li>
+ </ul></li>
+ <li><a href="interpreter/html/index.html">Interpreter</a></li>
+ <li><a href="jitrino/html/index.html">Jitrino</a>- the just-in-time compiler </li>
+ <li><a href="port/html/index.html">Porting Layer</a> - the extensions to APR</li>
+ <li><a href="thread/html/index.html">Thread Manager</a></li>
+ <li><a href="vmcore/html/index.html">VM Infrastructure</a> - the VM core component interfaces</li>
+ <li><a href="vmi/html/index.html">Class Library Support</a> - the VMI interface</li>
+ <li><a href="vmstart/html/index.html">Component Manager</a></li>
+ <li><a href="tests/html/index.html">DTLVM Tests</a></li>
+ <li><a href="drlvm/html/index.html">All DRLVM</a> - the big bundle with all of the above</li>
+ </ul>
+ </subsection>
+
+ <subsection name="Other Useful DRLVM documents">
+ <ul>
+ <li><a href="index.html" target="_blank">DRLVM
+ website documentation page</a> with links to all DRLVM documents</li>
+ <li><a href="http://wiki.apache.org/harmony/DRLVM_Documentation_Quality">Status
+ metrics for Doxygen API reference</a>, Wiki page with metrics that show improvement metrics for the reference </li>
+ </ul>
+ </subsection>
+</section>
+<section name="Regenerating the Reference">
+<p>
+Follow these instructions to regenerate reference materials analogous to those posted on the website. You can also adjust
+the list of files to include into a specific documentation bundle and configure Doxygen to produce a different output,
+see section <a href="#Advanced Tasks">Advanced Tasks</a>
+</p>
+<p>TBD</p>
+<subsection name="Advanced Tasks">
+<p>
+Generation of Doxygen reference is adjusted by the following files located in <code>trunk/vm/doc</code>:
+</p>
+<ul>
+<li><code>doc.properties</code> defines the input and output directories and the files included in each bundle
+</li>
+<li><code>build.xml</code> lists all doc build targets
+</li>
+<li><code>vm.cfg</code> is a copy of classlib configuration files and defines formatting and other output properties for Doxygen
+</li>
+
+</ul>
+</subsection>
+</section>
+</body>
+</document>
\ No newline at end of file
Modified: harmony/standard/site/xdocs/subcomponents/drlvm/index.xml
URL: http://svn.apache.org/viewvc/harmony/standard/site/xdocs/subcomponents/drlvm/index.xml?view=diff&rev=499808&r1=499807&r2=499808
==============================================================================
--- harmony/standard/site/xdocs/subcomponents/drlvm/index.xml (original)
+++ harmony/standard/site/xdocs/subcomponents/drlvm/index.xml Thu Jan 25 06:55:03 2007
@@ -141,6 +141,8 @@
gives info on specifics of the current implementation.
</li>
</ul>
+ <li><a href="DoxygenStart.html">DRLVM Source Code Generated Documentation Index</a>
+ </li>
</ul>
</subsection>
<subsection name="How-tos and Guides">