Author: gsingers
Date: Thu Oct 16 15:31:17 2008
New Revision: 705379
URL: http://svn.apache.org/viewvc?rev=705379&view=rev
Log:
MAHOUT-69: add in some javadocs, etc. Still needs work
Added:
lucene/mahout/trunk/core/src/main/java/org/apache/mahout/package.html
(with props)
lucene/mahout/trunk/core/src/main/java/overview.html (with props)
lucene/mahout/trunk/examples/src/main/java/org/apache/mahout/package.html
(with props)
lucene/mahout/trunk/examples/src/main/java/overview.html (with props)
Modified:
lucene/mahout/trunk/build.xml
lucene/mahout/trunk/core/build.xml
lucene/mahout/trunk/examples/build.xml
Modified: lucene/mahout/trunk/build.xml
URL:
http://svn.apache.org/viewvc/lucene/mahout/trunk/build.xml?rev=705379&r1=705378&r2=705379&view=diff
==============================================================================
--- lucene/mahout/trunk/build.xml (original)
+++ lucene/mahout/trunk/build.xml Thu Oct 16 15:31:17 2008
@@ -1,7 +1,7 @@
<?xml version="1.0" encoding="UTF-8"?>
<project name="mahout" default="dist" basedir=".">
- <import file="common-build.xml"/>
+ <import file="common-build.xml"/>
<target name="dist">
@@ -10,14 +10,53 @@
</target>
<target name="clean">
- <ant dir="core" antfile="build.xml" target="clean" />
- <ant dir="examples" antfile="build.xml" target="clean" />
+ <ant dir="core" antfile="build.xml" target="clean"/>
+ <ant dir="examples" antfile="build.xml" target="clean"/>
<delete dir="build"/>
- <delete dir="dist" />
+ <delete dir="dist"/>
</target>
+ <path id="javadoc.classpath">
+ <fileset dir="${shared-lib}">
+ <include name="*.jar" />
+ <exclude name="junit*.jar"/>
+ </fileset>
+ <fileset dir="core/lib">
+ <include name="*.jar" />
+ </fileset>
+ <fileset dir="examples/lib">
+ <include name="*.jar" />
+ </fileset>
+ </path>
+
+ <property name="Name" value="Apache Mahout"/>
<target name="javadoc">
+ <!-- build separate ones -->
<ant dir="core" antfile="build.xml" target="javadoc"/>
+ <ant dir="examples" antfile="build.xml" target="javadoc"/>
+ <!-- build a full one -->
+ <mkdir dir="${build.javadoc}"/>
+
+ <javadoc
+ destdir="${build.javadoc}"
+ author="true"
+ version="true"
+ failonerror="true"
+ use="true"
+ encoding="utf8"
+ overview="core/src/main/java/overview.html"
+ access="${javadoc.access}"
+ windowtitle="${Name} ${version} API"
+ doctitle="${Name} ${version} API (${specversion})"
+ bottom="Copyright &copy; ${javadoc.years} The Apache Software
Foundation"
+ >
+ <packageset dir="core/src/main/java"/>
+ <packageset dir="examples/src/main/java"/>
+ <link href="${javadoc.link.java}"/>
+ <link href="${javadoc.link.junit}"/>
+ <classpath refid="javadoc.classpath"/>
+ </javadoc>
+
</target>
<!-- make a distribution -->
@@ -28,28 +67,35 @@
<property name="fullname" value="apache-${ant.project.name}"/>
<property name="fullnamever"
value="apache-${ant.project.name}-${version}"/>
- <property name="dist" value="dist" />
+ <property name="dist" value="dist"/>
<mkdir dir="${dist}"/>
<tar destfile="${dist}/${fullnamever}.tgz" compression="gzip">
<tarfileset dir="."
- prefix="${fullnamever}"
- includes="KEYS LICENSE.txt NOTICE.txt README.txt build.xml pom.xml
lib/"
- excludes=""/>
+ prefix="${fullnamever}"
+ includes="KEYS LICENSE.txt NOTICE.txt README.txt build.xml
pom.xml lib/"
+ excludes=""/>
<tarfileset dir="./core"
- prefix="${fullnamever}/core"
- includes="build.properties build.xml taste-build.xml pom.xml src/ lib/"
- excludes=""/>
+ prefix="${fullnamever}/core"
+ includes="build.properties build.xml taste-build.xml pom.xml
src/ lib/"
+ excludes=""/>
<tarfileset dir="./examples"
- prefix="${fullnamever}/examples"
- includes="build.properties build.xml pom.xml src/ lib/"
- excludes=""/>
+ prefix="${fullnamever}/examples"
+ includes="build.properties build.xml pom.xml src/ lib/"
+ excludes=""/>
<tarfileset dir="./core/build/docs/api"
- prefix="${fullnamever}/docs/api" />
+ prefix="${fullnamever}/docs/core/api"/>
+
+ <tarfileset dir="./examples/build/docs/api"
+ prefix="${fullnamever}/docs/examples/api"/>
+ <!-- full set of apis -->
+ <tarfileset dir="./build/docs/api"
+ prefix="${fullnamever}/docs/api"/>
+
<tarfileset dir="./core/dist/"
- prefix="${fullnamever}"
- includes="*.jar"/>
+ prefix="${fullnamever}"
+ includes="*.jar"/>
</tar>
<!-- unpack tarball and create zipball -->
@@ -62,10 +108,10 @@
<zip destfile="${dist}/${fullnamever}.zip">
<zipfileset dir="${dest}/${fullnamever}"
- prefix="${fullnamever}"/>
+ prefix="${fullnamever}"/>
</zip>
- <delete dir="${dest}" />
+ <delete dir="${dest}"/>
<!-- pgp arm tgz and zip -->
<exec command="gpg --armor --output ${dist}/${fullnamever}.tgz.asc
--detach-sig ${dist}/${fullnamever}.tgz"/>
@@ -87,19 +133,19 @@
</target>
-<target name="-taskdef">
+ <target name="-taskdef">
<typedef resource="org/apache/rat/anttasks/antlib.xml"
uri="antlib:rat.anttasks">
<classpath>
<fileset dir="." includes="rat*.jar"/>
</classpath>
</typedef>
</target>
-<target name="rat-sources" depends="-taskdef"
- description="runs the tasks over src/java excluding the license directory">
+ <target name="rat-sources" depends="-taskdef"
+ description="runs the tasks over src/java excluding the license
directory">
<rat:report xmlns:rat="antlib:org.apache.rat.anttasks">
<fileset dir="core/src/main/java">
<exclude name="**/CHANGES.*"/>
- </fileset>
+ </fileset>
<fileset dir="examples/src/main/java">
<exclude name="**/CHANGES.*"/>
</fileset>
Modified: lucene/mahout/trunk/core/build.xml
URL:
http://svn.apache.org/viewvc/lucene/mahout/trunk/core/build.xml?rev=705379&r1=705378&r2=705379&view=diff
==============================================================================
--- lucene/mahout/trunk/core/build.xml (original)
+++ lucene/mahout/trunk/core/build.xml Thu Oct 16 15:31:17 2008
@@ -48,11 +48,6 @@
<property name="junit.excludes" value="**/MatrixTest.java,
**/DefaultDistanceMeasureTest.java,
**/DefaultWeightedDistanceMeasureTest.java"/>
- <path id="junit-path">
- <pathelement location="${junit-location.jar}"/>
- </path>
-
-
<!-- The compilation classpath -->
<path id="compile.classpath">
<fileset dir="${shared-lib}">
@@ -142,6 +137,7 @@
use="true"
encoding="utf8"
access="${javadoc.access}"
+ overview="./src/main/java/overview.html"
windowtitle="${Name} ${version} API"
doctitle="${Name} ${version} API (${specversion})"
bottom="Copyright &copy; ${javadoc.years} The Apache Software
Foundation"
Added: lucene/mahout/trunk/core/src/main/java/org/apache/mahout/package.html
URL:
http://svn.apache.org/viewvc/lucene/mahout/trunk/core/src/main/java/org/apache/mahout/package.html?rev=705379&view=auto
==============================================================================
--- lucene/mahout/trunk/core/src/main/java/org/apache/mahout/package.html
(added)
+++ lucene/mahout/trunk/core/src/main/java/org/apache/mahout/package.html Thu
Oct 16 15:31:17 2008
@@ -0,0 +1,32 @@
+<HTML>
+ <!--
+ /**
+ * 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.
+ */
+
+ --><HEAD>
+ <TITLE>org.apache.mahout</TITLE>
+</HEAD>
+<BODY>
+<DIV>Welcome to the Apache Mahout project. To get started, it's probably best
to have a look
+ at the <a href="http://cwiki.apache.org/MAHOUT";>Mahout wiki</a>
+</DIV>
+<DIV> </DIV>
+<DIV align="center">
+Copyright © 2008 <A HREF="http://lucene.apache.org/mahout";>Apache
Software Foundation - Mahout</A>
+</DIV>
+</BODY>
+</HTML>
\ No newline at end of file
Propchange:
lucene/mahout/trunk/core/src/main/java/org/apache/mahout/package.html
------------------------------------------------------------------------------
svn:eol-style = native
Added: lucene/mahout/trunk/core/src/main/java/overview.html
URL:
http://svn.apache.org/viewvc/lucene/mahout/trunk/core/src/main/java/overview.html?rev=705379&view=auto
==============================================================================
--- lucene/mahout/trunk/core/src/main/java/overview.html (added)
+++ lucene/mahout/trunk/core/src/main/java/overview.html Thu Oct 16 15:31:17
2008
@@ -0,0 +1,16 @@
+<HTML>
+ <!--
+ *
+ --><HEAD>
+ <TITLE>Welcome to Apache Mahout!</TITLE>
+</HEAD>
+<BODY>
+<DIV>Welcome to the Apache Mahout project. To get started, it's probably best
to have a look
+ at the <a href="http://cwiki.apache.org/MAHOUT";>Mahout wiki</a>
+</DIV>
+<DIV> </DIV>
+<DIV align="center">
+Copyright © 2008 <A HREF="http://lucene.apache.org/mahout";>Apache
Mahout</A>
+</DIV>
+</BODY>
+</HTML>
\ No newline at end of file
Propchange: lucene/mahout/trunk/core/src/main/java/overview.html
------------------------------------------------------------------------------
svn:eol-style = native
Modified: lucene/mahout/trunk/examples/build.xml
URL:
http://svn.apache.org/viewvc/lucene/mahout/trunk/examples/build.xml?rev=705379&r1=705378&r2=705379&view=diff
==============================================================================
--- lucene/mahout/trunk/examples/build.xml (original)
+++ lucene/mahout/trunk/examples/build.xml Thu Oct 16 15:31:17 2008
@@ -122,6 +122,7 @@
failonerror="true"
use="true"
encoding="utf8"
+ overview="./src/main/java/overview.html"
access="${javadoc.access}"
windowtitle="${Name} ${version} API"
doctitle="${Name} ${version} API (${specversion})"
Added: lucene/mahout/trunk/examples/src/main/java/org/apache/mahout/package.html
URL:
http://svn.apache.org/viewvc/lucene/mahout/trunk/examples/src/main/java/org/apache/mahout/package.html?rev=705379&view=auto
==============================================================================
--- lucene/mahout/trunk/examples/src/main/java/org/apache/mahout/package.html
(added)
+++ lucene/mahout/trunk/examples/src/main/java/org/apache/mahout/package.html
Thu Oct 16 15:31:17 2008
@@ -0,0 +1,32 @@
+<HTML>
+ <!--
+ /**
+ * 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.
+ */
+
+ --><HEAD>
+ <TITLE>org.apache.mahout</TITLE>
+</HEAD>
+<BODY>
+<DIV>Welcome to the Apache Mahout project. To get started, it's probably best
to have a look
+ at the <a href="http://cwiki.apache.org/MAHOUT";>Mahout wiki</a>
+</DIV>
+<DIV> </DIV>
+<DIV align="center">
+Copyright © 2008 <A HREF="http://lucene.apache.org/mahout";>Apache
Software Foundation - Mahout</A>
+</DIV>
+</BODY>
+</HTML>
\ No newline at end of file
Propchange:
lucene/mahout/trunk/examples/src/main/java/org/apache/mahout/package.html
------------------------------------------------------------------------------
svn:eol-style = native
Added: lucene/mahout/trunk/examples/src/main/java/overview.html
URL:
http://svn.apache.org/viewvc/lucene/mahout/trunk/examples/src/main/java/overview.html?rev=705379&view=auto
==============================================================================
--- lucene/mahout/trunk/examples/src/main/java/overview.html (added)
+++ lucene/mahout/trunk/examples/src/main/java/overview.html Thu Oct 16
15:31:17 2008
@@ -0,0 +1,16 @@
+<HTML>
+ <!--
+ *
+ --><HEAD>
+ <TITLE>Welcome to Apache Mahout!</TITLE>
+</HEAD>
+<BODY>
+<DIV>Welcome to the Apache Mahout project. To get started, it's probably best
to have a look
+ at the <a href="http://cwiki.apache.org/MAHOUT";>Mahout wiki</a>
+</DIV>
+<DIV> </DIV>
+<DIV align="center">
+Copyright © 2008 <A HREF="http://lucene.apache.org/mahout";>Apache
Mahout</A>
+</DIV>
+</BODY>
+</HTML>
\ No newline at end of file
Propchange: lucene/mahout/trunk/examples/src/main/java/overview.html
------------------------------------------------------------------------------
svn:eol-style = native
