revert of r1639217 and offline-linking for maven javadocs

git-svn-id: https://svn.apache.org/repos/asf/poi/trunk@1639807 13f79535-47bb-0310-9956-ffa450edef68
2014-11-15 00:00:30 +00:00 · 2014-11-15 00:00:30 +00:00 · 3f77a96e47
parent 39ba1ba707
commit 3f77a96e47
6 changed files with 34 additions and 15 deletions
--- a/build.xml
+++ b/build.xml
@ -1264,7 +1264,7 @@ under the License.
        <echo>Use mvn-deploy.sh to deploy the artifacts in the remote repository</echo>
    </target>

-    <target name="jar" depends="compile-all, compile-version" description="Creates jar files for distribution">
+    <target name="-manifest">
        <manifest file="build/poi-manifest.mf">
            <attribute name="Built-By" value="${user.name}"/>
            <attribute name="Specification-Title" value="Apache POI"/>
@ -1275,6 +1275,9 @@ under the License.
            <attribute name="Implementation-Vendor-Id" value="org.apache.poi"/>
            <attribute name="Implementation-Vendor" value="The Apache Software Foundation"/>
        </manifest>
+    </target>
+
+    <target name="jar" depends="compile-all, compile-version, -manifest" description="Creates jar files for distribution">
        <jar destfile="${dist.dir}/${jar.name}-${version.id}-${DSTAMP}.jar"
             manifest="build/poi-manifest.mf">
            <fileset dir="${main.output.dir}"/>
@ -1335,7 +1338,21 @@ under the License.
        </jar>
    </target>

-    <target name="jar-javadocs" description="JavaDocs for Maven">
+
+    <target name="-do-jar-check-javadocs-package-list">
+        <condition property="javadocs.package-list.present">
+        	<available file="build/tmp/site/build/site/apidocs/package-list"/>
+        </condition>
+    </target>
+
+    <target name="-do-jar-create-javadocs-package-list"
+    	depends="-do-jar-check-javadocs-package-list"
+    	unless="javadocs.package-list.present">
+    	<antcall target="javadocs"/>
+    </target>
+	
+	
+	<target name="jar-javadocs" description="JavaDocs for Maven" depends="compile,-manifest,-do-jar-create-javadocs-package-list">
        <property name="build.maven.javadocs" location="build/tmp/maven-javadocs"/>

        <!-- Build and package the main javadocs -->
@ -1354,7 +1371,8 @@ under the License.
           <param name="jarname" value="${jar.name}-ooxml" />
        </antcall>
    </target>
-    <target name="-do-jar-javadocs">
+
+	<target name="-do-jar-javadocs">
        <echo message="Building ${jarname} javadocs from ${srcfolder}" />
        <delete dir="${build.maven.javadocs}"/>
        <mkdir dir="${build.maven.javadocs}"/>
@ -1365,6 +1383,7 @@ under the License.
            <packageset dir="${srcfolder}" defaultexcludes="yes">
                <include name="org/apache/poi/**"/>
            </packageset>
+            <link href="https://poi.apache.org/apidocs" packagelistLoc="build/tmp/site/build/site/apidocs"/>
        </javadoc>
        <jar destfile="${dist.dir}/${jarname}-${version.id}-javadocs-${DSTAMP}.jar"
             manifest="build/poi-manifest.mf">
--- a/src/java/org/apache/poi/POIOLE2TextExtractor.java
+++ b/src/java/org/apache/poi/POIOLE2TextExtractor.java
@ -28,10 +28,10 @@ import org.apache.poi.poifs.filesystem.POIFSFileSystem;
 * You will typically find the implementation of
 *  a given format's text extractor under
 *  org.apache.poi.[format].extractor .
- * @see <a href="https://poi.apache.org/apidocs/org/apache/poi/hssf/extractor/ExcelExtractor.html">org.apache.poi.hssf.extractor.ExcelExtractor</a>
- * @see <a href="https://poi.apache.org/apidocs/org/apache/poi/hslf/extractor/PowerPointExtractor.html">org.apache.poi.hslf.extractor.PowerPointExtractor</a>
- * @see <a href="https://poi.apache.org/apidocs/org/apache/poi/hdgf/extractor/VisioTextExtractor.html">org.apache.poi.hdgf.extractor.VisioTextExtractor</a>
- * @see <a href="https://poi.apache.org/apidocs/org/apache/poi/hwpf/extractor/WordExtractor.html">org.apache.poi.hwpf.extractor.WordExtractor</a>
+ * @see org.apache.poi.hssf.extractor.ExcelExtractor
+ * @see org.apache.poi.hslf.extractor.PowerPointExtractor
+ * @see org.apache.poi.hdgf.extractor.VisioTextExtractor
+ * @see org.apache.poi.hwpf.extractor.WordExtractor
 */
 public abstract class POIOLE2TextExtractor extends POITextExtractor {
 	/**
--- a/src/java/org/apache/poi/POITextExtractor.java
+++ b/src/java/org/apache/poi/POITextExtractor.java
@ -25,10 +25,10 @@ import java.io.IOException;
 * You will typically find the implementation of
 *  a given format's text extractor under
 *  org.apache.poi.[format].extractor .
- * @see <a href="https://poi.apache.org/apidocs/org/apache/poi/hssf/extractor/ExcelExtractor.html">org.apache.poi.hssf.extractor.ExcelExtractor</a>
- * @see <a href="https://poi.apache.org/apidocs/org/apache/poi/hslf/extractor/PowerPointExtractor.html">org.apache.poi.hslf.extractor.PowerPointExtractor</a>
- * @see <a href="https://poi.apache.org/apidocs/org/apache/poi/hdgf/extractor/VisioTextExtractor.html">org.apache.poi.hdgf.extractor.VisioTextExtractor</a>
- * @see <a href="https://poi.apache.org/apidocs/org/apache/poi/hwpf/extractor/WordExtractor.html">org.apache.poi.hwpf.extractor.WordExtractor</a>
+ * @see org.apache.poi.hssf.extractor.ExcelExtractor
+ * @see org.apache.poi.hslf.extractor.PowerPointExtractor
+ * @see org.apache.poi.hdgf.extractor.VisioTextExtractor
+ * @see org.apache.poi.hwpf.extractor.WordExtractor
 */
 public abstract class POITextExtractor implements Closeable {
 	/** The POIDocument that's open */
--- a/src/java/org/apache/poi/poifs/crypt/package.html
+++ b/src/java/org/apache/poi/poifs/crypt/package.html
@ -27,7 +27,7 @@
 <ul>
 <li>This package contains common functions for both current implemented cipher modes.</li>
 <li>the {@link org.apache.poi.poifs.crypt.standard standard} package is part of the base poi jar and contains classes for the standard encryption ...</li>
-<li>the <a href="https://poi.apache.org/apidocs/org/apache/poi/poifs/crypt/agile/package-summary.html">agile</a> package is part of the poi ooxml jar and the provides agile encryption support.</li>
+<li>the {@link org.apache.poi.poifs.crypt.agile agile} package is part of the poi ooxml jar and the provides agile encryption support.</li>
 </ul>

 <h2>Related Documentation</h2>
@ -39,6 +39,6 @@ Some implementations informations can be found under:

 <!-- Put @see and @since tags down here. -->
@see org.apache.poi.poifs.crypt.standard
-@see <a href="https://poi.apache.org/apidocs/org/apache/poi/poifs/crypt/agile/package-summary.html">org.apache.poi.poifs.crypt.agile</a>
+@see org.apache.poi.poifs.crypt.agile
 </body>
 </html>
--- a/src/java/org/apache/poi/ss/formula/eval/forked/ForkedEvaluator.java
+++ b/src/java/org/apache/poi/ss/formula/eval/forked/ForkedEvaluator.java
@ -36,7 +36,7 @@ import org.apache.poi.ss.usermodel.Workbook;
 /**
 * An alternative workbook evaluator that saves memory in situations where a single workbook is
 * concurrently and independently evaluated many times.  With standard formula evaluation, around
- * 90% of memory consumption is due to loading of the {@link HSSFWorkbook} or <a href="https://poi.apache.org/apidocs/org/apache/poi/xssf/usermodel/XSSFWorkbook.html">XSSFWorkbook</a>.
+ * 90% of memory consumption is due to loading of the {@link HSSFWorkbook} or {@link org.apache.poi.xssf.usermodel.XSSFWorkbook}.
 * This class enables a 'master workbook' to be loaded just once and shared between many evaluation
 * clients.  Each evaluation client creates its own {@link ForkedEvaluator} and can set cell values
 * that will be used for local evaluations (and don't disturb evaluations on other evaluators).
--- a/src/java/org/apache/poi/util/XMLHelper.java
+++ b/src/java/org/apache/poi/util/XMLHelper.java
@ -22,7 +22,7 @@ import javax.xml.parsers.DocumentBuilderFactory;

 /**
 * Helper methods for working with javax.xml classes.
- * @see <a href="https://poi.apache.org/apidocs/org/apache/poi/util/SAXHelper.html">org.apache.poi.util.SAXHelper</a>
+ * @see org.apache.poi.util.SAXHelper
 */
 public final class XMLHelper
 {