db-derby-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From krist...@apache.org
Subject svn commit: r1186707 - in /db/derby/site/trunk: build/site/manuals/index.html src/documentation/content/xdocs/manuals/index.xml
Date Thu, 20 Oct 2011 10:04:45 GMT
Author: kristwaa
Date: Thu Oct 20 10:04:44 2011
New Revision: 1186707

URL: http://svn.apache.org/viewvc?rev=1186707&view=rev
Log:
DERBY-5464: Add easier to find links to Derby JavaDoc on the Derby web site

Added links to the internal API documentation under the documentation tab.

Patch file: derby-5464-1c-javadoc_links.diff
--bhis line, and those below, will be ignored--

M    build/site/manuals/index.html
M    src/documentation/content/xdocs/manuals/index.xml

Modified:
    db/derby/site/trunk/build/site/manuals/index.html
    db/derby/site/trunk/src/documentation/content/xdocs/manuals/index.xml

Modified: db/derby/site/trunk/build/site/manuals/index.html
URL: http://svn.apache.org/viewvc/db/derby/site/trunk/build/site/manuals/index.html?rev=1186707&r1=1186706&r2=1186707&view=diff
==============================================================================
--- db/derby/site/trunk/build/site/manuals/index.html (original)
+++ db/derby/site/trunk/build/site/manuals/index.html Thu Oct 20 10:04:44 2011
@@ -193,6 +193,9 @@ document.write("Last Published: " + docu
 <a href="#docs_10.0">10.0 Manuals</a>
 </li>
 <li>
+<a href="#javadoc">Internal API documentation</a>
+</li>
+<li>
 <a href="#doc_issues">Reporting Documentation Issues</a>
 </li>
 </ul>
@@ -281,13 +284,24 @@ A description of each manual is below:
      </p>
    
 </li>
+   
+<li>
+<p>
+<em>Internal API documentation</em>:
+      Automatically generated API documentation that describes packages, 
+      classes, methods and parameters in the source code. The grammar for
+      SQL (as implemented in Derby) and ij is also described in BNF.
+      Generally useful only for Derby developers.
+     </p>
+   
+</li>
 
 
 </ul>
 </div>
 
 
-<a name="N10060"></a><a name="latest"></a>
+<a name="N10067"></a><a name="latest"></a>
 <h2 class="boxed">Latest Alpha Manuals</h2>
 <div class="section">
 <p>The latest development version of the manuals,  corresponding to the
@@ -432,7 +446,7 @@ Derby alpha codeline, are listed in this
 </div>
 
 
-<a name="N101CA"></a><a name="docs_10.8"></a>
+<a name="N101D1"></a><a name="docs_10.8"></a>
 <h2 class="boxed">10.8 Manuals</h2>
 <div class="section">
 <p>The 10.8 manuals are listed in this section.
@@ -516,7 +530,7 @@ Derby alpha codeline, are listed in this
 </div>
 
 
-<a name="N1029D"></a><a name="docs_10.7"></a>
+<a name="N102A4"></a><a name="docs_10.7"></a>
 <h2 class="boxed">10.7 Manuals</h2>
 <div class="section">
 <p>The 10.7 manuals are listed in this section.
@@ -600,7 +614,7 @@ Derby alpha codeline, are listed in this
 </div>
 
 
-<a name="N10370"></a><a name="docs_10.6"></a>
+<a name="N10377"></a><a name="docs_10.6"></a>
 <h2 class="boxed">10.6 Manuals</h2>
 <div class="section">
 <p>The 10.6 manuals are listed in this section.
@@ -684,7 +698,7 @@ Derby alpha codeline, are listed in this
 </div>
 
 
-<a name="N10443"></a><a name="docs_10.5"></a>
+<a name="N1044A"></a><a name="docs_10.5"></a>
 <h2 class="boxed">10.5 Manuals</h2>
 <div class="section">
 <p>The 10.5 manuals are listed in this section.
@@ -768,7 +782,7 @@ Derby alpha codeline, are listed in this
 </div>
 
 
-<a name="N10516"></a><a name="docs_10.4"></a>
+<a name="N1051D"></a><a name="docs_10.4"></a>
 <h2 class="boxed">10.4 Manuals</h2>
 <div class="section">
 <p>The 10.4 manuals are listed in this section.
@@ -852,7 +866,7 @@ Derby alpha codeline, are listed in this
 </div>
 
 
-<a name="N105E9"></a><a name="docs_10.3"></a>
+<a name="N105F0"></a><a name="docs_10.3"></a>
 <h2 class="boxed">10.3 Manuals</h2>
 <div class="section">
 <p>The 10.3 manuals are listed in this section.
@@ -936,7 +950,7 @@ Derby alpha codeline, are listed in this
 </div>
 
 
-<a name="N106BC"></a><a name="docs_10.2"></a>
+<a name="N106C3"></a><a name="docs_10.2"></a>
 <h2 class="boxed">10.2 Manuals</h2>
 <div class="section">
 <p>The 10.2 manuals are listed in this section.
@@ -1066,7 +1080,7 @@ Derby alpha codeline, are listed in this
 </div>
 
 
-<a name="N1080B"></a><a name="docs_10.1"></a>
+<a name="N10812"></a><a name="docs_10.1"></a>
 <h2 class="boxed">10.1 Manuals</h2>
 <div class="section">
 <p>
@@ -1157,7 +1171,7 @@ discussions about format.
 </div>
 
 
-<a name="N108E6"></a><a name="docs_10.0"></a>
+<a name="N108ED"></a><a name="docs_10.0"></a>
 <h2 class="boxed">10.0 Manuals</h2>
 <div class="section">
 <p>
@@ -1249,8 +1263,51 @@ to see if the problem still exists in th
 </div>
 
 
+<a name="N10999"></a><a name="javadoc"></a>
+<h2 class="boxed">Internal API documentation</h2>
+<div class="section">
+<p>A recent version of the internal API documentation for Derby.</p>
+<table class="ForrestTable" cellspacing="1" cellpadding="4">
+     
+<tr>
+        
+<th colspan="2" rowspan="1">English</th>
+     
+</tr>
+     
+<tr>
+        
+<td colspan="1" rowspan="1">Engine</td>
+        <td colspan="1" rowspan="1"><a target="_blank" class="fork" href="http://db.apache.org/derby/javadoc/engine/">HTML
Pages</a></td>
+     
+</tr>
+     
+<tr>
+        
+<td colspan="1" rowspan="1">Language (grammar)</td>
+        <td colspan="1" rowspan="1"><a target="_blank" class="fork" href="http://db.apache.org/derby/javadoc/language/">HTML
Pages</a></td>
+     
+</tr>
+     
+<tr>
+        
+<td colspan="1" rowspan="1">Testing</td>
+        <td colspan="1" rowspan="1"><a target="_blank" class="fork" href="http://db.apache.org/derby/javadoc/testing/">HTML
Pages</a></td>
+     
+</tr>
+     
+<tr>
+         
+<td colspan="1" rowspan="1">Tools (grammar)</td>
+        <td colspan="1" rowspan="1"><a target="_blank" class="fork" href="http://db.apache.org/derby/javadoc/tools/">HTML
Pages</a></td>
+     
+</tr>
+  
+</table>
+</div>
+
 
-<a name="N10992"></a><a name="doc_issues"></a>
+<a name="N109EE"></a><a name="doc_issues"></a>
 <h2 class="boxed">Reporting Documentation Issues</h2>
 <div class="section">
 <p>

Modified: db/derby/site/trunk/src/documentation/content/xdocs/manuals/index.xml
URL: http://svn.apache.org/viewvc/db/derby/site/trunk/src/documentation/content/xdocs/manuals/index.xml?rev=1186707&r1=1186706&r2=1186707&view=diff
==============================================================================
--- db/derby/site/trunk/src/documentation/content/xdocs/manuals/index.xml (original)
+++ db/derby/site/trunk/src/documentation/content/xdocs/manuals/index.xml Thu Oct 20 10:04:44
2011
@@ -73,6 +73,13 @@ A description of each manual is below:
      <code>sysinfo</code>, and describes bulk export and import.
      </p>
    </li>
+   <li><p><em>Internal API documentation</em>:
+      Automatically generated API documentation that describes packages, 
+      classes, methods and parameters in the source code. The grammar for
+      SQL (as implemented in Derby) and ij is also described in BNF.
+      Generally useful only for Derby developers.
+     </p>
+   </li>
 
 </ul>
 </section>
@@ -744,6 +751,33 @@ to see if the problem still exists in th
 </table>
 </section>
 
+<section id="javadoc">
+  <title>Internal API documentation</title>
+
+  <p>A recent version of the internal API documentation for Derby.</p>
+
+  <table>
+     <tr>
+        <th colspan="2">English</th>
+     </tr>
+     <tr>
+        <td>Engine</td>
+        <td><a class="fork" href="http://db.apache.org/derby/javadoc/engine/">HTML
Pages</a></td>
+     </tr>
+     <tr>
+        <td>Language (grammar)</td>
+        <td><a class="fork" href="http://db.apache.org/derby/javadoc/language/">HTML
Pages</a></td>
+     </tr>
+     <tr>
+        <td>Testing</td>
+        <td><a class="fork" href="http://db.apache.org/derby/javadoc/testing/">HTML
Pages</a></td>
+     </tr>
+     <tr>
+         <td>Tools (grammar)</td>
+        <td><a class="fork" href="http://db.apache.org/derby/javadoc/tools/">HTML
Pages</a></td>
+     </tr>
+  </table>
+</section>
 
 <section id="doc_issues">
   <title>Reporting Documentation Issues</title>



Mime
View raw message