You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@poi.apache.org by ni...@apache.org on 2018/10/30 12:27:53 UTC

svn commit: r1845230 - /poi/site/src/documentation/content/xdocs/apidocs/index.xml

Author: nick
Date: Tue Oct 30 12:27:52 2018
New Revision: 1845230

URL: http://svn.apache.org/viewvc?rev=1845230&view=rev
Log:
Other release javadoc info

Modified:
    poi/site/src/documentation/content/xdocs/apidocs/index.xml

Modified: poi/site/src/documentation/content/xdocs/apidocs/index.xml
URL: http://svn.apache.org/viewvc/poi/site/src/documentation/content/xdocs/apidocs/index.xml?rev=1845230&r1=1845229&r2=1845230&view=diff
==============================================================================
--- poi/site/src/documentation/content/xdocs/apidocs/index.xml (original)
+++ poi/site/src/documentation/content/xdocs/apidocs/index.xml Tue Oct 30 12:27:52 2018
@@ -21,27 +21,51 @@
 
 <document>
   <header>
-    <title>Apache POI - JavaDocs</title>
+    <title>Apache POI - Javadocs</title>
     <authors>
       <person id="PD" name="POI Developers" email="dev@poi.apache.org" />
     </authors>
   </header>
 
   <body>
-    <section><title>Apache POI JavaDocs</title>
+    <section><title>Apache POI Javadocs</title>
   <p>
-   The JavaDocs for the latest (development) version of Apache POI
+   The Javadocs for the latest (development) version of Apache POI
    can be <a href="/apidocs/dev/">accessed online here</a>, or build
    from a <a href="/devel/subversion.html">source code checkout</a>
    by running the <em>javadocs</em> Ant task.
   </p>
   <p>
-   TODO
+   For recent releases, the Javadocs for the latest stable release
+   in the family can also be browsed online:
   </p>
+  <ul>
+    <li><a href="/apidocs/3.17/">Apache POI 3.17 Javadocs</a></li>
+    <li><a href="/apidocs/4.0/">Apache POI 4.0.x Javadocs</a></li>
+  </ul>
 
   <section><title>Older Releases</title>
   <p>
-   TODO
+    For every release of Apache POI, the specific Javadocs for that
+    version are available with the release.
+  </p>
+  <p>
+    Maven / Gradle / IDE users are able to fetch the javadocs for each
+    of the Apache POI jars from Maven Central (or your preferred Maven
+    mirror). These are made available with the <em>javadoc</em> classifier,
+    eg <em>group: 'org.apache.poi', name: 'poi', version: '4.0.1', 
+           classifier: 'javaodc'</em>
+  </p>
+  <p>
+    If you have downloaded the <em>binary (bin)</em> release, then you
+    can find the Javadocs within the download in the <em>/apidocs/</em>
+    folder.
+  </p>
+  <p>
+    If you have downloaded the <em>source (src)</em> release, then you
+    need to build your own copy. Run the <em>javadocs</em> ant task
+    to have the Javadocs built, the build will tell you the output
+    directory at the end (it varies slightly between POI versions).
   </p>
   </section>
 </section>



---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@poi.apache.org
For additional commands, e-mail: commits-help@poi.apache.org