incubator-crunch-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From m...@apache.org
Subject git commit: CRUNCH-95: Improve Javadocs.
Date Sun, 14 Oct 2012 20:01:12 GMT
Updated Branches:
  refs/heads/master c3ba38e24 -> 43c4e83a2


CRUNCH-95: Improve Javadocs.

Configure javadoc plugin to include only the client-side API.
Add package-info files for all published interfaces.


Project: http://git-wip-us.apache.org/repos/asf/incubator-crunch/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-crunch/commit/43c4e83a
Tree: http://git-wip-us.apache.org/repos/asf/incubator-crunch/tree/43c4e83a
Diff: http://git-wip-us.apache.org/repos/asf/incubator-crunch/diff/43c4e83a

Branch: refs/heads/master
Commit: 43c4e83a2412d55408a73db98e025ef4cf495aca
Parents: c3ba38e
Author: Matthias Friedrich <matt@mafr.de>
Authored: Sun Oct 7 20:56:01 2012 +0200
Committer: Matthias Friedrich <matt@mafr.de>
Committed: Sun Oct 14 11:05:09 2012 +0200

----------------------------------------------------------------------
 crunch-contrib/pom.xml                             |   28 +++++++++-----
 .../crunch/contrib/bloomfilter/package-info.java   |    6 ++-
 .../org/apache/crunch/contrib/package-info.java    |    8 +++--
 .../org/apache/crunch/examples/package-info.java   |   22 +++++++++++
 .../java/org/apache/crunch/test/package-info.java  |    2 +-
 .../java/org/apache/crunch/fn/package-info.java    |   22 +++++++++++
 .../org/apache/crunch/impl/mem/package-info.java   |   22 +++++++++++
 .../org/apache/crunch/impl/mr/package-info.java    |   22 +++++++++++
 .../java/org/apache/crunch/io/package-info.java    |   22 +++++++++++
 .../org/apache/crunch/lib/join/package-info.java   |   22 +++++++++++
 .../java/org/apache/crunch/lib/package-info.java   |   22 +++++++++++
 .../main/java/org/apache/crunch/package-info.java  |   25 +++++++++++++
 .../org/apache/crunch/types/avro/package-info.java |   22 +++++++++++
 .../apache/crunch/types/writable/package-info.java |   22 +++++++++++
 pom.xml                                            |   22 +++++++++++
 15 files changed, 273 insertions(+), 16 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/incubator-crunch/blob/43c4e83a/crunch-contrib/pom.xml
----------------------------------------------------------------------
diff --git a/crunch-contrib/pom.xml b/crunch-contrib/pom.xml
index ef0c4ff..c96f219 100644
--- a/crunch-contrib/pom.xml
+++ b/crunch-contrib/pom.xml
@@ -1,13 +1,21 @@
-<!-- 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. -->
+<!--
+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.
+-->
 <project
   xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd"
 xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
   <modelVersion>4.0.0</modelVersion>

http://git-wip-us.apache.org/repos/asf/incubator-crunch/blob/43c4e83a/crunch-contrib/src/main/java/org/apache/crunch/contrib/bloomfilter/package-info.java
----------------------------------------------------------------------
diff --git a/crunch-contrib/src/main/java/org/apache/crunch/contrib/bloomfilter/package-info.java
b/crunch-contrib/src/main/java/org/apache/crunch/contrib/bloomfilter/package-info.java
index 8ce703e..1ca0b41 100644
--- a/crunch-contrib/src/main/java/org/apache/crunch/contrib/bloomfilter/package-info.java
+++ b/crunch-contrib/src/main/java/org/apache/crunch/contrib/bloomfilter/package-info.java
@@ -17,8 +17,10 @@
  */
 
 /** 
- * BloomFilters are space and time efficient and Hadoop has support for creating
- * them.This package provides support for creating BloomFilters in crunch.
+ * Support for creating Bloom Filters.
+ *
+ * Bloom Filters are space and time efficient data structures supported by
+ * Hadoop. This package provides support for creating them in Crunch.
  */
 package org.apache.crunch.contrib.bloomfilter;
 

http://git-wip-us.apache.org/repos/asf/incubator-crunch/blob/43c4e83a/crunch-contrib/src/main/java/org/apache/crunch/contrib/package-info.java
----------------------------------------------------------------------
diff --git a/crunch-contrib/src/main/java/org/apache/crunch/contrib/package-info.java b/crunch-contrib/src/main/java/org/apache/crunch/contrib/package-info.java
index 7f5eee7..cb1da7d 100644
--- a/crunch-contrib/src/main/java/org/apache/crunch/contrib/package-info.java
+++ b/crunch-contrib/src/main/java/org/apache/crunch/contrib/package-info.java
@@ -17,9 +17,11 @@
  */
 
 /**
- *  The package contains some interesting contributions from the users of
- *  crunch.These interesting things did not have a place in the core library of crunch 
- *  but they are quite useful for the users of crunch. 
+ * User contributions that may be interesting for special applications.
+ *
+ * Things included in this package or its subpackages are maintained
+ * by the Crunch team, but are too specialized to include them in the
+ * core library.
  */
 package org.apache.crunch.contrib;
 

http://git-wip-us.apache.org/repos/asf/incubator-crunch/blob/43c4e83a/crunch-examples/src/main/java/org/apache/crunch/examples/package-info.java
----------------------------------------------------------------------
diff --git a/crunch-examples/src/main/java/org/apache/crunch/examples/package-info.java b/crunch-examples/src/main/java/org/apache/crunch/examples/package-info.java
new file mode 100644
index 0000000..8e1cbca
--- /dev/null
+++ b/crunch-examples/src/main/java/org/apache/crunch/examples/package-info.java
@@ -0,0 +1,22 @@
+/**
+ * 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.
+ */
+
+/**
+ * Example applications demonstrating various aspects of Crunch.
+ */
+package org.apache.crunch.examples;

http://git-wip-us.apache.org/repos/asf/incubator-crunch/blob/43c4e83a/crunch-test/src/main/java/org/apache/crunch/test/package-info.java
----------------------------------------------------------------------
diff --git a/crunch-test/src/main/java/org/apache/crunch/test/package-info.java b/crunch-test/src/main/java/org/apache/crunch/test/package-info.java
index fc6b606..fef2147 100644
--- a/crunch-test/src/main/java/org/apache/crunch/test/package-info.java
+++ b/crunch-test/src/main/java/org/apache/crunch/test/package-info.java
@@ -17,6 +17,6 @@
  */
 
 /**
- * Provides a collection of test utilities.
+ * Utilities for testing Crunch-based applications.
  */
 package org.apache.crunch.test;

http://git-wip-us.apache.org/repos/asf/incubator-crunch/blob/43c4e83a/crunch/src/main/java/org/apache/crunch/fn/package-info.java
----------------------------------------------------------------------
diff --git a/crunch/src/main/java/org/apache/crunch/fn/package-info.java b/crunch/src/main/java/org/apache/crunch/fn/package-info.java
new file mode 100644
index 0000000..acefdff
--- /dev/null
+++ b/crunch/src/main/java/org/apache/crunch/fn/package-info.java
@@ -0,0 +1,22 @@
+/**
+ * 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.
+ */
+
+/**
+ * Commonly used functions for manipulating collections.
+ */
+package org.apache.crunch.fn;

http://git-wip-us.apache.org/repos/asf/incubator-crunch/blob/43c4e83a/crunch/src/main/java/org/apache/crunch/impl/mem/package-info.java
----------------------------------------------------------------------
diff --git a/crunch/src/main/java/org/apache/crunch/impl/mem/package-info.java b/crunch/src/main/java/org/apache/crunch/impl/mem/package-info.java
new file mode 100644
index 0000000..a55b673
--- /dev/null
+++ b/crunch/src/main/java/org/apache/crunch/impl/mem/package-info.java
@@ -0,0 +1,22 @@
+/**
+ * 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.
+ */
+
+/**
+ * In-memory Pipeline implementation for rapid prototyping and testing.
+ */
+package org.apache.crunch.impl.mem;

http://git-wip-us.apache.org/repos/asf/incubator-crunch/blob/43c4e83a/crunch/src/main/java/org/apache/crunch/impl/mr/package-info.java
----------------------------------------------------------------------
diff --git a/crunch/src/main/java/org/apache/crunch/impl/mr/package-info.java b/crunch/src/main/java/org/apache/crunch/impl/mr/package-info.java
new file mode 100644
index 0000000..7e403c3
--- /dev/null
+++ b/crunch/src/main/java/org/apache/crunch/impl/mr/package-info.java
@@ -0,0 +1,22 @@
+/**
+ * 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.
+ */
+
+/**
+ * A Pipeline implementation that runs on Hadoop MapReduce.
+ */
+package org.apache.crunch.impl.mr;

http://git-wip-us.apache.org/repos/asf/incubator-crunch/blob/43c4e83a/crunch/src/main/java/org/apache/crunch/io/package-info.java
----------------------------------------------------------------------
diff --git a/crunch/src/main/java/org/apache/crunch/io/package-info.java b/crunch/src/main/java/org/apache/crunch/io/package-info.java
new file mode 100644
index 0000000..022bc99
--- /dev/null
+++ b/crunch/src/main/java/org/apache/crunch/io/package-info.java
@@ -0,0 +1,22 @@
+/**
+ * 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.
+ */
+
+/**
+ * Data input and output for Pipelines.
+ */
+package org.apache.crunch.io;

http://git-wip-us.apache.org/repos/asf/incubator-crunch/blob/43c4e83a/crunch/src/main/java/org/apache/crunch/lib/join/package-info.java
----------------------------------------------------------------------
diff --git a/crunch/src/main/java/org/apache/crunch/lib/join/package-info.java b/crunch/src/main/java/org/apache/crunch/lib/join/package-info.java
new file mode 100644
index 0000000..f1ad9f1
--- /dev/null
+++ b/crunch/src/main/java/org/apache/crunch/lib/join/package-info.java
@@ -0,0 +1,22 @@
+/**
+ * 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.
+ */
+
+/**
+ * Inner and outer joins on collections.
+ */
+package org.apache.crunch.lib.join;

http://git-wip-us.apache.org/repos/asf/incubator-crunch/blob/43c4e83a/crunch/src/main/java/org/apache/crunch/lib/package-info.java
----------------------------------------------------------------------
diff --git a/crunch/src/main/java/org/apache/crunch/lib/package-info.java b/crunch/src/main/java/org/apache/crunch/lib/package-info.java
new file mode 100644
index 0000000..2695787
--- /dev/null
+++ b/crunch/src/main/java/org/apache/crunch/lib/package-info.java
@@ -0,0 +1,22 @@
+/**
+ * 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.
+ */
+
+/**
+ * Joining, sorting, aggregating, and other commonly used functionality.
+ */
+package org.apache.crunch.lib;

http://git-wip-us.apache.org/repos/asf/incubator-crunch/blob/43c4e83a/crunch/src/main/java/org/apache/crunch/package-info.java
----------------------------------------------------------------------
diff --git a/crunch/src/main/java/org/apache/crunch/package-info.java b/crunch/src/main/java/org/apache/crunch/package-info.java
new file mode 100644
index 0000000..40d9f33
--- /dev/null
+++ b/crunch/src/main/java/org/apache/crunch/package-info.java
@@ -0,0 +1,25 @@
+/**
+ * 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.
+ */
+
+/**
+ * Client-facing API and core abstractions.
+ *
+ * @see <a href="http://incubator.apache.org/crunch/intro.html">Introduction to
+ *      Apache Crunch</a>
+ */
+package org.apache.crunch;

http://git-wip-us.apache.org/repos/asf/incubator-crunch/blob/43c4e83a/crunch/src/main/java/org/apache/crunch/types/avro/package-info.java
----------------------------------------------------------------------
diff --git a/crunch/src/main/java/org/apache/crunch/types/avro/package-info.java b/crunch/src/main/java/org/apache/crunch/types/avro/package-info.java
new file mode 100644
index 0000000..abaf60f
--- /dev/null
+++ b/crunch/src/main/java/org/apache/crunch/types/avro/package-info.java
@@ -0,0 +1,22 @@
+/**
+ * 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.
+ */
+
+/**
+ * Business object serialization using Apache Avro.
+ */
+package org.apache.crunch.types.avro;

http://git-wip-us.apache.org/repos/asf/incubator-crunch/blob/43c4e83a/crunch/src/main/java/org/apache/crunch/types/writable/package-info.java
----------------------------------------------------------------------
diff --git a/crunch/src/main/java/org/apache/crunch/types/writable/package-info.java b/crunch/src/main/java/org/apache/crunch/types/writable/package-info.java
new file mode 100644
index 0000000..7d54743
--- /dev/null
+++ b/crunch/src/main/java/org/apache/crunch/types/writable/package-info.java
@@ -0,0 +1,22 @@
+/**
+ * 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.
+ */
+
+/**
+ * Business object serialization using Hadoop's Writables framework.
+ */
+package org.apache.crunch.types.writable;

http://git-wip-us.apache.org/repos/asf/incubator-crunch/blob/43c4e83a/pom.xml
----------------------------------------------------------------------
diff --git a/pom.xml b/pom.xml
index 3ec2af0..00391b1 100644
--- a/pom.xml
+++ b/pom.xml
@@ -82,6 +82,7 @@ under the License.
     <mockito.version>1.9.0</mockito.version>
     <scala.version>2.9.2</scala.version>
     <scalatest.version>1.7.2</scalatest.version>
+    <pkg>org.apache.crunch</pkg>
   </properties>
 
   <scm>
@@ -552,6 +553,25 @@ under the License.
         <configuration>
           <show>public</show>
           <nohelp>true</nohelp>
+          <excludePackageNames>${pkg}.hadoop.*:${pkg}.impl.mr.*:${pkg}.impl.mem.*:${pkg}.io.*:${pkg}.materialize:${pkg}.scrunch</excludePackageNames>
+          <groups>
+            <group>
+              <title>Core</title>
+              <packages>${pkg}:${pkg}.fn:${pkg}.impl.*:${pkg}.io:${pkg}.types.*:${pkg}.test</packages>
+            </group>
+            <group>
+              <title>Extension Library</title>
+              <packages>${pkg}.lib:${pkg}.lib.*</packages>
+            </group>
+            <group>
+              <title>User-contributed Functionality</title>
+              <packages>${pkg}.contrib:${pkg}.contrib.*</packages>
+            </group>
+            <group>
+              <title>Examples</title>
+              <packages>${pkg}.examples</packages>
+            </group>
+          </groups>
         </configuration>
         <executions>
           <execution>
@@ -752,6 +772,8 @@ under the License.
                 <configuration>
                   <show>public</show> 
                   <nohelp>true</nohelp>
+                  <subpackages>org.apache.crunch;org.apache.crunch.fn</subpackages>
+                  <excludePackageNames>org.apache.crunch.impl.*</excludePackageNames>
                 </configuration>         
                 <reportSets>
                   <reportSet>


Mime
View raw message