You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@pig.apache.org by da...@apache.org on 2010/04/23 00:40:09 UTC

svn commit: r937091 - in /hadoop/pig/branches/branch-0.7: CHANGES.txt build.xml src/docs/src/documentation/content/xdocs/site.xml

Author: daijy
Date: Thu Apr 22 22:40:09 2010
New Revision: 937091

URL: http://svn.apache.org/viewvc?rev=937091&view=rev
Log:
PIG-1384: Adding contrib javadoc to main Pig javadoc

Modified:
    hadoop/pig/branches/branch-0.7/CHANGES.txt
    hadoop/pig/branches/branch-0.7/build.xml
    hadoop/pig/branches/branch-0.7/src/docs/src/documentation/content/xdocs/site.xml

Modified: hadoop/pig/branches/branch-0.7/CHANGES.txt
URL: http://svn.apache.org/viewvc/hadoop/pig/branches/branch-0.7/CHANGES.txt?rev=937091&r1=937090&r2=937091&view=diff
==============================================================================
--- hadoop/pig/branches/branch-0.7/CHANGES.txt (original)
+++ hadoop/pig/branches/branch-0.7/CHANGES.txt Thu Apr 22 22:40:09 2010
@@ -68,6 +68,8 @@ manner (rding via pradeepkth)
 
 IMPROVEMENTS
 
+PIG-1384: Adding contrib javadoc to main Pig javadoc (daijy)
+
 PIG-1320: final documentation updates for Pig 0.7.0 (chandec via olgan)
 
 PIG-1330: Move pruned schema tracking logic from LoadFunc to core code (daijy)

Modified: hadoop/pig/branches/branch-0.7/build.xml
URL: http://svn.apache.org/viewvc/hadoop/pig/branches/branch-0.7/build.xml?rev=937091&r1=937090&r2=937091&view=diff
==============================================================================
--- hadoop/pig/branches/branch-0.7/build.xml (original)
+++ hadoop/pig/branches/branch-0.7/build.xml Thu Apr 22 22:40:09 2010
@@ -332,10 +332,29 @@
         </javadoc>
     </target>
 
+    <target name="javadoc-all" depends="jar, ivy-javadoc" description="Create documentation including all contrib projects">
+        <mkdir dir="${build.javadoc}" />
+        <javadoc overview="${src.dir}/overview.html" packagenames="org.apache.pig*,org.apache.hadoop.zebra*" destdir="${build.javadoc}" author="true" version="true" use="true" windowtitle="${Name} ${version} API" doctitle="${Name} ${version} API" bottom="Copyright &amp;copy; ${year} The Apache Software Foundation">
+            <packageset dir="${src.dir}" />
+            <packageset dir="contrib/piggybank/java/src/main/java"/>
+            <packageset dir="contrib/zebra/src/java"/>
+            <link href="${javadoc.link.java}" />
+            <classpath>
+                <path refid="javadoc-classpath" />
+            	<pathelement path="${output.jarfile}" />
+                <fileset dir="build">
+                    <include name="**/zebra-*-dev.jar"/>
+                </fileset>
+            </classpath>
+            <group title="pig" packages="org.apache.pig*" />
+            <group title="contrib: Piggybank" packages="org.apache.pig.piggybank*" />
+            <group title="contrib: Zebra" packages="org.apache.hadoop.zebra*"/>
+        </javadoc>
+    </target>
     <!-- ================================================================== -->
     <!-- @depricated, Documentation                                         -->
     <!-- ================================================================== -->
-    <target name="docs" depends="forrest.check, javadoc" description="Generate forrest-based documentation. 
+    <target name="docs" depends="forrest.check, javadoc-all" description="Generate forrest-based documentation. 
 		To use, specify -Dforrest.home=&lt;base of Apache Forrest installation&gt; on the command line." if="forrest.home">
     	<exec dir="${docs.dir}" executable="${forrest.home}/bin/forrest"
           failonerror="true">
@@ -818,7 +837,7 @@
         </clover-report>
      </target>
 
-     <target name="api-xml" depends="ivy-jdiff, javadoc, write-null">
+     <target name="api-xml" depends="ivy-jdiff, javadoc-all, write-null">
         <javadoc>
                 <doclet name="jdiff.JDiff"
                         path="${jdiff.jar}:${xerces.jar}">

Modified: hadoop/pig/branches/branch-0.7/src/docs/src/documentation/content/xdocs/site.xml
URL: http://svn.apache.org/viewvc/hadoop/pig/branches/branch-0.7/src/docs/src/documentation/content/xdocs/site.xml?rev=937091&r1=937090&r2=937091&view=diff
==============================================================================
--- hadoop/pig/branches/branch-0.7/src/docs/src/documentation/content/xdocs/site.xml (original)
+++ hadoop/pig/branches/branch-0.7/src/docs/src/documentation/content/xdocs/site.xml Thu Apr 22 22:40:09 2010
@@ -49,13 +49,6 @@ See http://forrest.apache.org/docs/linki
     <udf label="UDFs" href="udf.html" />
     </docs>  
     
-     <docs label="Pig Miscellaneous"> 
-     <api	label="API Docs" href="ext:api"/>
-     <wiki  label="Wiki" href="ext:wiki" />
-     <faq  label="FAQ" href="ext:faq" />
-     <relnotes  label="Release Notes" 	href="ext:relnotes" />
-    </docs>
-
     <docs label="Zebra"> 
      <zover label="Zebra Overview "	href="zebra_overview.html" />
      <zusers label="Zebra Users "	href="zebra_users.html" />
@@ -65,7 +58,7 @@ See http://forrest.apache.org/docs/linki
      <zstream label="Zebra Streaming "	href="zebra_stream.html" />
     </docs>
      <docs label="Miscellaneous"> 
-     <api	label="API Docs"					href="ext:api"/>
+     <api	label="API Docs"					href="api/"/>
      <wiki  label="Wiki"               			href="ext:wiki" />
      <faq  label="FAQ"                			href="ext:faq" />
      <relnotes  label="Release Notes" 	href="ext:relnotes" />