From c11d32faed441c0fdf564c7fb5aac6723b339f14 Mon Sep 17 00:00:00 2001 From: Tomoko Uchida Date: Sat, 29 Aug 2020 22:28:03 +0900 Subject: [PATCH] LUCENE-9441: Fix ant-specific Javadoc links in accordance with Gradle build --- gradle/validation/check-broken-links.gradle | 5 ++--- .../apache/lucene/collation/package-info.java | 2 +- .../org/apache/lucene/analysis/Analyzer.java | 16 ++++++++-------- .../org/apache/lucene/analysis/package-info.java | 8 ++++---- lucene/core/src/java/overview.html | 4 ++-- lucene/demo/src/java/overview.html | 2 +- 6 files changed, 18 insertions(+), 19 deletions(-) diff --git a/gradle/validation/check-broken-links.gradle b/gradle/validation/check-broken-links.gradle index 28104750372..e9d1a11eeb5 100644 --- a/gradle/validation/check-broken-links.gradle +++ b/gradle/validation/check-broken-links.gradle @@ -26,13 +26,12 @@ configure(rootProject) { } } + configure(subprojects.findAll { it.path in [':lucene', ':solr'] }) { task checkBrokenLinks(type: CheckBrokenLinksTask, 'dependsOn': 'documentation') - // TODO: uncomment this line after fixing all broken links. - // (we can't fix the cross-project links until ant build is disabled.) - // check.dependsOn checkBrokenLinks + check.dependsOn checkBrokenLinks } class CheckBrokenLinksTask extends DefaultTask { diff --git a/lucene/analysis/common/src/java/org/apache/lucene/collation/package-info.java b/lucene/analysis/common/src/java/org/apache/lucene/collation/package-info.java index 5b83ea5ef31..c79b58cc088 100644 --- a/lucene/analysis/common/src/java/org/apache/lucene/collation/package-info.java +++ b/lucene/analysis/common/src/java/org/apache/lucene/collation/package-info.java @@ -145,7 +145,7 @@ * * *

- * ICUCollationKeyAnalyzer, available in the icu analysis module, + * ICUCollationKeyAnalyzer, available in the icu analysis module, * uses ICU4J's Collator, which * makes its version available, thus allowing collation to be versioned * independently from the JVM. ICUCollationKeyAnalyzer is also diff --git a/lucene/core/src/java/org/apache/lucene/analysis/Analyzer.java b/lucene/core/src/java/org/apache/lucene/analysis/Analyzer.java index b9a798b97e5..2749c1cb700 100644 --- a/lucene/core/src/java/org/apache/lucene/analysis/Analyzer.java +++ b/lucene/core/src/java/org/apache/lucene/analysis/Analyzer.java @@ -64,19 +64,19 @@ import org.apache.lucene.util.Version; *

* For some concrete implementations bundled with Lucene, look in the analysis modules: *

* @@ -103,7 +103,7 @@ public abstract class Analyzer implements Closeable { *

* NOTE: if you just want to reuse on a per-field basis, it's easier to * use a subclass of {@link AnalyzerWrapper} such as - * + * * PerFieldAnalyerWrapper instead. */ public Analyzer(ReuseStrategy reuseStrategy) { diff --git a/lucene/core/src/java/org/apache/lucene/analysis/package-info.java b/lucene/core/src/java/org/apache/lucene/analysis/package-info.java index b7e752c4578..83736aec4c3 100644 --- a/lucene/core/src/java/org/apache/lucene/analysis/package-info.java +++ b/lucene/core/src/java/org/apache/lucene/analysis/package-info.java @@ -158,10 +158,10 @@ * supplies a large family of Analyzer classes that deliver useful * analysis chains. The most common of these is the StandardAnalyzer. * Many applications will have a long and industrious life with nothing more - * than the StandardAnalyzer. The analyzers-common + * than the StandardAnalyzer. The analyzers-common * library provides many pre-existing analyzers for various languages. * The analysis-common library also allows to configure a custom Analyzer without subclassing using the - * CustomAnalyzer + * CustomAnalyzer * class. *

*

@@ -170,7 +170,7 @@ * all under the 'analysis' directory of the distribution. Some of * these support particular languages, others integrate external * components. The 'common' subdirectory has some noteworthy - * general-purpose analyzers, including the PerFieldAnalyzerWrapper. Most Analyzers perform the same operation on all + * general-purpose analyzers, including the PerFieldAnalyzerWrapper. Most Analyzers perform the same operation on all * {@link org.apache.lucene.document.Field}s. The PerFieldAnalyzerWrapper can be used to associate a different Analyzer with different * {@link org.apache.lucene.document.Field}s. There is a great deal of * functionality in the analysis area, you should study it carefully to @@ -253,7 +253,7 @@ * Tokenizer, and TokenFilter(s) (optional) — or components you * create, or a combination of existing and newly created components. Before * pursuing this approach, you may find it worthwhile to explore the - * analyzers-common library and/or ask on the + * analyzers-common library and/or ask on the * java-user@lucene.apache.org mailing list first to see if what you * need already exists. If you are still committed to creating your own * Analyzer, have a look at the source code of any one of the many samples diff --git a/lucene/core/src/java/overview.html b/lucene/core/src/java/overview.html index 95d158900de..9338742bd30 100644 --- a/lucene/core/src/java/overview.html +++ b/lucene/core/src/java/overview.html @@ -72,8 +72,8 @@ an enumeration of token {@link org.apache.lucene.util.Attribute Attribute}s.&nbs A TokenStream can be composed by applying {@link org.apache.lucene.analysis.TokenFilter TokenFilter}s to the output of a {@link org.apache.lucene.analysis.Tokenizer Tokenizer}.  Tokenizers and TokenFilters are strung together and applied with an {@link org.apache.lucene.analysis.Analyzer Analyzer}.  -analyzers-common provides a number of Analyzer implementations, including -StopAnalyzer +analyzers-common provides a number of Analyzer implementations, including +StopAnalyzer and the grammar-based StandardAnalyzer.

  • diff --git a/lucene/demo/src/java/overview.html b/lucene/demo/src/java/overview.html index 8f1a08a609f..d3a1c12a0fe 100644 --- a/lucene/demo/src/java/overview.html +++ b/lucene/demo/src/java/overview.html @@ -151,7 +151,7 @@ have less value for searching. It should be noted that there are different rules for every language, and you should use the proper analyzer for each. Lucene currently provides Analyzers for a number of different languages (see the javadocs under lucene/analysis/common/src/java/org/apache/lucene/analysis).

    +"../analysis/common/overview-summary.html">lucene/analysis/common/src/java/org/apache/lucene/analysis).

    The IndexWriterConfig instance holds all configuration for IndexWriter. For example, we set the OpenMode to use here based on the value