From 798fd49a763d60baa1dea0fff36816dccdd121f1 Mon Sep 17 00:00:00 2001 From: Robert Muir Date: Mon, 24 Sep 2012 02:56:46 +0000 Subject: [PATCH] LUCENE-4409: implement javadocs linting with eclipse ecj compiler git-svn-id: https://svn.apache.org/repos/asf/lucene/dev/trunk@1389188 13f79535-47bb-0310-9956-ffa450edef68 --- lucene/analysis/build.xml | 4 + lucene/build.xml | 9 +- lucene/common-build.xml | 44 +++++++++ lucene/module-build.xml | 2 - .../lucene/spatial/bbox/package-info.java | 24 ----- .../apache/lucene/spatial/bbox/package.html | 23 +++++ .../apache/lucene/spatial/package-info.java | 26 ------ .../org/apache/lucene/spatial/package.html | 24 +++++ .../lucene/spatial/prefix/package-info.java | 22 ----- .../apache/lucene/spatial/prefix/package.html | 21 +++++ .../spatial/prefix/tree/package-info.java | 28 ------ .../lucene/spatial/prefix/tree/package.html | 29 ++++++ .../lucene/spatial/query/package-info.java | 25 ----- .../apache/lucene/spatial/query/package.html | 21 +++++ lucene/tools/javadoc/ecj.javadocs.prefs | 91 +++++++++++++++++++ solr/build.xml | 10 +- .../dataimporthandler-extras/build.xml | 2 + solr/solrj/build.xml | 14 +++ 18 files changed, 290 insertions(+), 129 deletions(-) delete mode 100644 lucene/spatial/src/java/org/apache/lucene/spatial/bbox/package-info.java create mode 100644 lucene/spatial/src/java/org/apache/lucene/spatial/bbox/package.html delete mode 100644 lucene/spatial/src/java/org/apache/lucene/spatial/package-info.java create mode 100644 lucene/spatial/src/java/org/apache/lucene/spatial/package.html delete mode 100644 lucene/spatial/src/java/org/apache/lucene/spatial/prefix/package-info.java create mode 100644 lucene/spatial/src/java/org/apache/lucene/spatial/prefix/package.html delete mode 100644 lucene/spatial/src/java/org/apache/lucene/spatial/prefix/tree/package-info.java create mode 100644 lucene/spatial/src/java/org/apache/lucene/spatial/prefix/tree/package.html delete mode 100644 lucene/spatial/src/java/org/apache/lucene/spatial/query/package-info.java create mode 100644 lucene/spatial/src/java/org/apache/lucene/spatial/query/package.html create mode 100644 lucene/tools/javadoc/ecj.javadocs.prefs diff --git a/lucene/analysis/build.xml b/lucene/analysis/build.xml index 2636bd22f9d..27a600934fc 100644 --- a/lucene/analysis/build.xml +++ b/lucene/analysis/build.xml @@ -126,5 +126,9 @@ + + + + diff --git a/lucene/build.xml b/lucene/build.xml index f1db31e8562..ecf40e58966 100644 --- a/lucene/build.xml +++ b/lucene/build.xml @@ -225,9 +225,16 @@ - + + + + + + + + @@ -1475,6 +1476,49 @@ ${tests-output}/junit4-*.suites - per-JVM executed suites + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/lucene/module-build.xml b/lucene/module-build.xml index f10f8b847d0..4d4246b2729 100644 --- a/lucene/module-build.xml +++ b/lucene/module-build.xml @@ -28,8 +28,6 @@ - - diff --git a/lucene/spatial/src/java/org/apache/lucene/spatial/bbox/package-info.java b/lucene/spatial/src/java/org/apache/lucene/spatial/bbox/package-info.java deleted file mode 100644 index d67148b2f13..00000000000 --- a/lucene/spatial/src/java/org/apache/lucene/spatial/bbox/package-info.java +++ /dev/null @@ -1,24 +0,0 @@ -/* - * 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. - */ - -/** - * Bounding Box Spatial Strategy - * - * Index a shape extent using 4 numeric fields and a flag to say if it crosses the dateline - */ -package org.apache.lucene.spatial.bbox; - diff --git a/lucene/spatial/src/java/org/apache/lucene/spatial/bbox/package.html b/lucene/spatial/src/java/org/apache/lucene/spatial/bbox/package.html new file mode 100644 index 00000000000..7e34e71f319 --- /dev/null +++ b/lucene/spatial/src/java/org/apache/lucene/spatial/bbox/package.html @@ -0,0 +1,23 @@ + + + +Bounding Box Spatial Strategy +

+Index a shape extent using 4 numeric fields and a flag to say if it crosses the dateline + + diff --git a/lucene/spatial/src/java/org/apache/lucene/spatial/package-info.java b/lucene/spatial/src/java/org/apache/lucene/spatial/package-info.java deleted file mode 100644 index 618e5af1134..00000000000 --- a/lucene/spatial/src/java/org/apache/lucene/spatial/package-info.java +++ /dev/null @@ -1,26 +0,0 @@ -/* - * 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. - */ - - -/** - * Lucene spatial search - * - * Check: - * http://blog.notdot.net/2009/11/Damn-Cool-Algorithms-Spatial-indexing-with-Quadtrees-and-Hilbert-Curves - */ -package org.apache.lucene.spatial; - diff --git a/lucene/spatial/src/java/org/apache/lucene/spatial/package.html b/lucene/spatial/src/java/org/apache/lucene/spatial/package.html new file mode 100644 index 00000000000..1099216c1a9 --- /dev/null +++ b/lucene/spatial/src/java/org/apache/lucene/spatial/package.html @@ -0,0 +1,24 @@ + + + +Lucene spatial search +

+Check: +http://blog.notdot.net/2009/11/Damn-Cool-Algorithms-Spatial-indexing-with-Quadtrees-and-Hilbert-Curves + + diff --git a/lucene/spatial/src/java/org/apache/lucene/spatial/prefix/package-info.java b/lucene/spatial/src/java/org/apache/lucene/spatial/prefix/package-info.java deleted file mode 100644 index e4ea3bc7fc5..00000000000 --- a/lucene/spatial/src/java/org/apache/lucene/spatial/prefix/package-info.java +++ /dev/null @@ -1,22 +0,0 @@ -/* - * 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. - */ - -/** - * Prefix Tree Strategy - */ -package org.apache.lucene.spatial.prefix; - diff --git a/lucene/spatial/src/java/org/apache/lucene/spatial/prefix/package.html b/lucene/spatial/src/java/org/apache/lucene/spatial/prefix/package.html new file mode 100644 index 00000000000..fe4cc69e1d6 --- /dev/null +++ b/lucene/spatial/src/java/org/apache/lucene/spatial/prefix/package.html @@ -0,0 +1,21 @@ + + + +Prefix Tree Strategy + + diff --git a/lucene/spatial/src/java/org/apache/lucene/spatial/prefix/tree/package-info.java b/lucene/spatial/src/java/org/apache/lucene/spatial/prefix/tree/package-info.java deleted file mode 100644 index 563501814b4..00000000000 --- a/lucene/spatial/src/java/org/apache/lucene/spatial/prefix/tree/package-info.java +++ /dev/null @@ -1,28 +0,0 @@ -/* - * 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. - */ - -/** - * The Spatial Prefix package supports spatial indexing by index-time tokens - * where adding characters to a string gives greater resolution. - * - * Potential Implementations include: - * * http://en.wikipedia.org/wiki/Quadtree - * * http://en.wikipedia.org/wiki/Geohash - * * http://healpix.jpl.nasa.gov/ - */ -package org.apache.lucene.spatial.prefix.tree; - diff --git a/lucene/spatial/src/java/org/apache/lucene/spatial/prefix/tree/package.html b/lucene/spatial/src/java/org/apache/lucene/spatial/prefix/tree/package.html new file mode 100644 index 00000000000..4d0df22d518 --- /dev/null +++ b/lucene/spatial/src/java/org/apache/lucene/spatial/prefix/tree/package.html @@ -0,0 +1,29 @@ + + + +The Spatial Prefix package supports spatial indexing by index-time tokens +where adding characters to a string gives greater resolution. +

+Potential Implementations include: +

    +
  • http://en.wikipedia.org/wiki/Quadtree +
  • http://en.wikipedia.org/wiki/Geohash +
  • http://healpix.jpl.nasa.gov/ +
+ + diff --git a/lucene/spatial/src/java/org/apache/lucene/spatial/query/package-info.java b/lucene/spatial/src/java/org/apache/lucene/spatial/query/package-info.java deleted file mode 100644 index 120004d3265..00000000000 --- a/lucene/spatial/src/java/org/apache/lucene/spatial/query/package-info.java +++ /dev/null @@ -1,25 +0,0 @@ -/* - * 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. - */ - -/** - * Spatial Query options - *
    - *
  • useful for client side requests
    • - *
- */ -package org.apache.lucene.spatial.query; - diff --git a/lucene/spatial/src/java/org/apache/lucene/spatial/query/package.html b/lucene/spatial/src/java/org/apache/lucene/spatial/query/package.html new file mode 100644 index 00000000000..1a71061b744 --- /dev/null +++ b/lucene/spatial/src/java/org/apache/lucene/spatial/query/package.html @@ -0,0 +1,21 @@ + + + +Spatial Query options useful for client side requests + + diff --git a/lucene/tools/javadoc/ecj.javadocs.prefs b/lucene/tools/javadoc/ecj.javadocs.prefs new file mode 100644 index 00000000000..c4952058f69 --- /dev/null +++ b/lucene/tools/javadoc/ecj.javadocs.prefs @@ -0,0 +1,91 @@ +#Sun Sep 23 20:55:03 EDT 2012 +eclipse.preferences.version=1 +org.eclipse.jdt.core.compiler.codegen.targetPlatform=1.6 +org.eclipse.jdt.core.compiler.compliance=1.6 +org.eclipse.jdt.core.compiler.doc.comment.support=enabled +org.eclipse.jdt.core.compiler.problem.annotationSuperInterface=ignore +org.eclipse.jdt.core.compiler.problem.assertIdentifier=error +org.eclipse.jdt.core.compiler.problem.autoboxing=ignore +org.eclipse.jdt.core.compiler.problem.comparingIdentical=ignore +org.eclipse.jdt.core.compiler.problem.deadCode=ignore +org.eclipse.jdt.core.compiler.problem.deprecation=ignore +org.eclipse.jdt.core.compiler.problem.deprecationInDeprecatedCode=disabled +org.eclipse.jdt.core.compiler.problem.deprecationWhenOverridingDeprecatedMethod=disabled +org.eclipse.jdt.core.compiler.problem.discouragedReference=ignore +org.eclipse.jdt.core.compiler.problem.emptyStatement=ignore +org.eclipse.jdt.core.compiler.problem.enumIdentifier=error +org.eclipse.jdt.core.compiler.problem.fallthroughCase=ignore +org.eclipse.jdt.core.compiler.problem.fatalOptionalError=disabled +org.eclipse.jdt.core.compiler.problem.fieldHiding=ignore +org.eclipse.jdt.core.compiler.problem.finalParameterBound=ignore +org.eclipse.jdt.core.compiler.problem.finallyBlockNotCompletingNormally=ignore +org.eclipse.jdt.core.compiler.problem.forbiddenReference=ignore +org.eclipse.jdt.core.compiler.problem.hiddenCatchBlock=ignore +org.eclipse.jdt.core.compiler.problem.includeNullInfoFromAsserts=disabled +org.eclipse.jdt.core.compiler.problem.incompatibleNonInheritedInterfaceMethod=ignore +org.eclipse.jdt.core.compiler.problem.incompleteEnumSwitch=ignore +org.eclipse.jdt.core.compiler.problem.indirectStaticAccess=ignore +org.eclipse.jdt.core.compiler.problem.invalidJavadoc=error +org.eclipse.jdt.core.compiler.problem.invalidJavadocTags=enabled +org.eclipse.jdt.core.compiler.problem.invalidJavadocTagsDeprecatedRef=disabled +org.eclipse.jdt.core.compiler.problem.invalidJavadocTagsNotVisibleRef=disabled +org.eclipse.jdt.core.compiler.problem.invalidJavadocTagsVisibility=private +org.eclipse.jdt.core.compiler.problem.localVariableHiding=ignore +org.eclipse.jdt.core.compiler.problem.methodWithConstructorName=ignore +org.eclipse.jdt.core.compiler.problem.missingDeprecatedAnnotation=ignore +org.eclipse.jdt.core.compiler.problem.missingHashCodeMethod=ignore +org.eclipse.jdt.core.compiler.problem.missingJavadocComments=ignore +org.eclipse.jdt.core.compiler.problem.missingJavadocCommentsOverriding=disabled +org.eclipse.jdt.core.compiler.problem.missingJavadocCommentsVisibility=public +org.eclipse.jdt.core.compiler.problem.missingJavadocTagDescription=all_standard_tags +org.eclipse.jdt.core.compiler.problem.missingJavadocTags=ignore +org.eclipse.jdt.core.compiler.problem.missingJavadocTagsMethodTypeParameters=disabled +org.eclipse.jdt.core.compiler.problem.missingJavadocTagsOverriding=disabled +org.eclipse.jdt.core.compiler.problem.missingJavadocTagsVisibility=public +org.eclipse.jdt.core.compiler.problem.missingOverrideAnnotation=ignore +org.eclipse.jdt.core.compiler.problem.missingOverrideAnnotationForInterfaceMethodImplementation=enabled +org.eclipse.jdt.core.compiler.problem.missingSerialVersion=ignore +org.eclipse.jdt.core.compiler.problem.missingSynchronizedOnInheritedMethod=ignore +org.eclipse.jdt.core.compiler.problem.noEffectAssignment=ignore +org.eclipse.jdt.core.compiler.problem.noImplicitStringConversion=ignore +org.eclipse.jdt.core.compiler.problem.nonExternalizedStringLiteral=ignore +org.eclipse.jdt.core.compiler.problem.nullReference=ignore +org.eclipse.jdt.core.compiler.problem.overridingPackageDefaultMethod=ignore +org.eclipse.jdt.core.compiler.problem.parameterAssignment=ignore +org.eclipse.jdt.core.compiler.problem.possibleAccidentalBooleanAssignment=ignore +org.eclipse.jdt.core.compiler.problem.potentialNullReference=ignore +org.eclipse.jdt.core.compiler.problem.rawTypeReference=ignore +org.eclipse.jdt.core.compiler.problem.redundantNullCheck=ignore +org.eclipse.jdt.core.compiler.problem.redundantSpecificationOfTypeArguments=ignore +org.eclipse.jdt.core.compiler.problem.redundantSuperinterface=ignore +org.eclipse.jdt.core.compiler.problem.reportMethodCanBePotentiallyStatic=ignore +org.eclipse.jdt.core.compiler.problem.reportMethodCanBeStatic=ignore +org.eclipse.jdt.core.compiler.problem.specialParameterHidingField=disabled +org.eclipse.jdt.core.compiler.problem.staticAccessReceiver=ignore +org.eclipse.jdt.core.compiler.problem.suppressOptionalErrors=disabled +org.eclipse.jdt.core.compiler.problem.suppressWarnings=enabled +org.eclipse.jdt.core.compiler.problem.syntheticAccessEmulation=ignore +org.eclipse.jdt.core.compiler.problem.typeParameterHiding=ignore +org.eclipse.jdt.core.compiler.problem.unavoidableGenericTypeProblems=enabled +org.eclipse.jdt.core.compiler.problem.uncheckedTypeOperation=ignore +org.eclipse.jdt.core.compiler.problem.undocumentedEmptyBlock=ignore +org.eclipse.jdt.core.compiler.problem.unhandledWarningToken=ignore +org.eclipse.jdt.core.compiler.problem.unnecessaryElse=ignore +org.eclipse.jdt.core.compiler.problem.unnecessaryTypeCheck=ignore +org.eclipse.jdt.core.compiler.problem.unqualifiedFieldAccess=ignore +org.eclipse.jdt.core.compiler.problem.unusedDeclaredThrownException=ignore +org.eclipse.jdt.core.compiler.problem.unusedDeclaredThrownExceptionExemptExceptionAndThrowable=enabled +org.eclipse.jdt.core.compiler.problem.unusedDeclaredThrownExceptionIncludeDocCommentReference=enabled +org.eclipse.jdt.core.compiler.problem.unusedDeclaredThrownExceptionWhenOverriding=disabled +org.eclipse.jdt.core.compiler.problem.unusedImport=ignore +org.eclipse.jdt.core.compiler.problem.unusedLabel=ignore +org.eclipse.jdt.core.compiler.problem.unusedLocal=ignore +org.eclipse.jdt.core.compiler.problem.unusedObjectAllocation=ignore +org.eclipse.jdt.core.compiler.problem.unusedParameter=ignore +org.eclipse.jdt.core.compiler.problem.unusedParameterIncludeDocCommentReference=enabled +org.eclipse.jdt.core.compiler.problem.unusedParameterWhenImplementingAbstract=disabled +org.eclipse.jdt.core.compiler.problem.unusedParameterWhenOverridingConcrete=disabled +org.eclipse.jdt.core.compiler.problem.unusedPrivateMember=ignore +org.eclipse.jdt.core.compiler.problem.unusedWarningToken=ignore +org.eclipse.jdt.core.compiler.problem.varargsArgumentNeedCast=ignore +org.eclipse.jdt.core.compiler.source=1.6 diff --git a/solr/build.xml b/solr/build.xml index 938bbfb4213..197cbe75b8c 100644 --- a/solr/build.xml +++ b/solr/build.xml @@ -522,8 +522,16 @@ - + + + + + + + + + diff --git a/solr/contrib/dataimporthandler-extras/build.xml b/solr/contrib/dataimporthandler-extras/build.xml index 9ba37a5d281..b2fb410d4b0 100644 --- a/solr/contrib/dataimporthandler-extras/build.xml +++ b/solr/contrib/dataimporthandler-extras/build.xml @@ -89,6 +89,8 @@ + + diff --git a/solr/solrj/build.xml b/solr/solrj/build.xml index 429f4032348..758734a7f50 100644 --- a/solr/solrj/build.xml +++ b/solr/solrj/build.xml @@ -46,6 +46,20 @@ + + + + + + + + + + +