You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@lucene.apache.org by th...@apache.org on 2020/09/14 16:38:37 UTC
[lucene-solr] 19/39: LUCENE-9441: Fix ant-specific Javadoc links in
accordance with Gradle build
This is an automated email from the ASF dual-hosted git repository.
thelabdude pushed a commit to branch reference_impl_gradle_updates
in repository https://gitbox.apache.org/repos/asf/lucene-solr.git
commit 2d32436dea42bc5c768fca10a8e8de9f7c69bb05
Author: Tomoko Uchida <to...@gmail.com>
AuthorDate: Sat Aug 29 22:28:03 2020 +0900
LUCENE-9441: Fix ant-specific Javadoc links in accordance with Gradle build
---
gradle/validation/check-broken-links.gradle | 5 ++---
.../java/org/apache/lucene/collation/package-info.java | 2 +-
.../src/java/org/apache/lucene/analysis/Analyzer.java | 16 ++++++++--------
.../java/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 ed83a86..29dcd90 100644
--- a/gradle/validation/check-broken-links.gradle
+++ b/gradle/validation/check-broken-links.gradle
@@ -24,12 +24,11 @@ configure(rootProject) {
dependsOn ':solr:checkBrokenLinks'
}
}
+
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 5b83ea5..c79b58c 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 @@
* </li>
* </ol>
* <p>
- * <code>ICUCollationKeyAnalyzer</code>, available in the <a href="{@docRoot}/../analyzers-icu/overview-summary.html">icu analysis module</a>,
+ * <code>ICUCollationKeyAnalyzer</code>, available in the <a href="{@docRoot}/../icu/overview-summary.html">icu analysis module</a>,
* uses ICU4J's <code>Collator</code>, which
* makes its version available, thus allowing collation to be versioned
* independently from the JVM. <code>ICUCollationKeyAnalyzer</code> 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 b9a798b..2749c1c 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;
* <p>
* For some concrete implementations bundled with Lucene, look in the analysis modules:
* <ul>
- * <li><a href="{@docRoot}/../analyzers-common/overview-summary.html">Common</a>:
+ * <li><a href="{@docRoot}/../analysis/common/overview-summary.html">Common</a>:
* Analyzers for indexing content in different languages and domains.
- * <li><a href="{@docRoot}/../analyzers-icu/overview-summary.html">ICU</a>:
+ * <li><a href="{@docRoot}/../analysis/icu/overview-summary.html">ICU</a>:
* Exposes functionality from ICU to Apache Lucene.
- * <li><a href="{@docRoot}/../analyzers-kuromoji/overview-summary.html">Kuromoji</a>:
+ * <li><a href="{@docRoot}/../analysis/kuromoji/overview-summary.html">Kuromoji</a>:
* Morphological analyzer for Japanese text.
- * <li><a href="{@docRoot}/../analyzers-morfologik/overview-summary.html">Morfologik</a>:
+ * <li><a href="{@docRoot}/../analysis/morfologik/overview-summary.html">Morfologik</a>:
* Dictionary-driven lemmatization for the Polish language.
- * <li><a href="{@docRoot}/../analyzers-phonetic/overview-summary.html">Phonetic</a>:
+ * <li><a href="{@docRoot}/../analysis/phonetic/overview-summary.html">Phonetic</a>:
* Analysis for indexing phonetic signatures (for sounds-alike search).
- * <li><a href="{@docRoot}/../analyzers-smartcn/overview-summary.html">Smart Chinese</a>:
+ * <li><a href="{@docRoot}/../analysis/smartcn/overview-summary.html">Smart Chinese</a>:
* Analyzer for Simplified Chinese, which indexes words.
- * <li><a href="{@docRoot}/../analyzers-stempel/overview-summary.html">Stempel</a>:
+ * <li><a href="{@docRoot}/../analysis/stempel/overview-summary.html">Stempel</a>:
* Algorithmic Stemmer for the Polish Language.
* </ul>
*
@@ -103,7 +103,7 @@ public abstract class Analyzer implements Closeable {
* <p>
* NOTE: if you just want to reuse on a per-field basis, it's easier to
* use a subclass of {@link AnalyzerWrapper} such as
- * <a href="{@docRoot}/../analyzers-common/org/apache/lucene/analysis/miscellaneous/PerFieldAnalyzerWrapper.html">
+ * <a href="{@docRoot}/../analysis/common/org/apache/lucene/analysis/miscellaneous/PerFieldAnalyzerWrapper.html">
* PerFieldAnalyerWrapper</a> 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 b7e752c..83736ae 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 <code>Analyzer</code> classes that deliver useful
* analysis chains. The most common of these is the <a href="{@docRoot}/org/apache/lucene/analysis/standard/StandardAnalyzer.html">StandardAnalyzer</a>.
* Many applications will have a long and industrious life with nothing more
- * than the <code>StandardAnalyzer</code>. The <a href="{@docRoot}/../analyzers-common/overview-summary.html">analyzers-common</a>
+ * than the <code>StandardAnalyzer</code>. The <a href="{@docRoot}/../analysis/common/overview-summary.html">analyzers-common</a>
* library provides many pre-existing analyzers for various languages.
* The analysis-common library also allows to configure a custom Analyzer without subclassing using the
- * <a href="{@docRoot}/../analyzers-common/org/apache/lucene/analysis/custom/CustomAnalyzer.html">CustomAnalyzer</a>
+ * <a href="{@docRoot}/../analysis/common/org/apache/lucene/analysis/custom/CustomAnalyzer.html">CustomAnalyzer</a>
* class.
* </p>
* <p>
@@ -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 <a href="{@docRoot}/../analyzers-common/org/apache/lucene/analysis/miscellaneous/PerFieldAnalyzerWrapper.html">PerFieldAnalyzerWrapper</a>. Most <code>Analyzer</code>s perform the same operation on all
+ * general-purpose analyzers, including the <a href="{@docRoot}/../analysis/common/org/apache/lucene/analysis/miscellaneous/PerFieldAnalyzerWrapper.html">PerFieldAnalyzerWrapper</a>. Most <code>Analyzer</code>s perform the same operation on all
* {@link org.apache.lucene.document.Field}s. The PerFieldAnalyzerWrapper can be used to associate a different <code>Analyzer</code> 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) <i>(optional)</i> — 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
- * <a href="{@docRoot}/../analyzers-common/overview-summary.html">analyzers-common</a> library and/or ask on the
+ * <a href="{@docRoot}/../analysis/common/overview-summary.html">analyzers-common</a> library and/or ask on the
* <a href="http://lucene.apache.org/core/discussion.html">java-user@lucene.apache.org mailing list</a> 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 b8f21e9..ddccf1d 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}.
-<a href="../analyzers-common/overview-summary.html">analyzers-common</a> provides a number of Analyzer implementations, including
-<a href="../analyzers-common/org/apache/lucene/analysis/core/StopAnalyzer.html">StopAnalyzer</a>
+<a href="../analysis/common/overview-summary.html">analyzers-common</a> provides a number of Analyzer implementations, including
+<a href="../analysis/common/org/apache/lucene/analysis/core/StopAnalyzer.html">StopAnalyzer</a>
and the grammar-based <a href="org/apache/lucene/analysis/standard/StandardAnalyzer.html">StandardAnalyzer</a>.</li>
<li>
diff --git a/lucene/demo/src/java/overview.html b/lucene/demo/src/java/overview.html
index 8f1a08a..d3a1c12 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 <a href=
-"../analyzers-common/overview-summary.html">lucene/analysis/common/src/java/org/apache/lucene/analysis</a>).</p>
+"../analysis/common/overview-summary.html">lucene/analysis/common/src/java/org/apache/lucene/analysis</a>).</p>
<p>The <span class="codefrag">IndexWriterConfig</span> instance holds all
configuration for <span class="codefrag">IndexWriter</span>. For example, we
set the <span class="codefrag">OpenMode</span> to use here based on the value