Mark the ArticleExtractor API as @Deprecated. All callers should …

…move to the plugin-based API in v4.0+
chimbori · Jul 16, 2023 · fdabc21 · fdabc21
1 parent c99aeb1
commit fdabc21
Show file tree

Hide file tree

Showing 6 changed files with 11 additions and 1 deletion.
diff --git a/src/main/kotlin/com/chimbori/crux/articles/Article.kt b/src/main/kotlin/com/chimbori/crux/articles/Article.kt
@@ -6,6 +6,7 @@ import org.jsoup.nodes.Document
 import org.jsoup.nodes.Element
 
 /** Parsed result from a web page. */
+@Deprecated("Use [com.chimbori.crux.api.Resource] instead. See README.md for examples.")
 public data class Article(
  var canonicalUrl: HttpUrl,
  var title: String? = null,

diff --git a/src/main/kotlin/com/chimbori/crux/articles/ArticleExtractor.kt b/src/main/kotlin/com/chimbori/crux/articles/ArticleExtractor.kt
@@ -1,3 +1,5 @@
+@file:Suppress("DEPRECATION")
+
 package com.chimbori.crux.articles
 
 import com.chimbori.crux.common.estimatedReadingTimeMinutes
@@ -17,7 +19,7 @@ import org.jsoup.Jsoup
 import org.jsoup.nodes.Document
 import org.jsoup.nodes.Element
 
-@Suppress("unused")
+@Deprecated("Use [com.chimbori.crux.plugins.ArticleExtractor] instead. See README.md for examples.")
 public class ArticleExtractor
 /**
  * Create an [ArticleExtractor] from an already-parsed JSoup document, to be used when a

diff --git a/src/main/kotlin/com/chimbori/crux/articles/ExtractImages.kt b/src/main/kotlin/com/chimbori/crux/articles/ExtractImages.kt
@@ -1,3 +1,4 @@
+@file:Suppress("DEPRECATION")
 
 package com.chimbori.crux.articles
 

diff --git a/src/test/kotlin/com/chimbori/crux/articles/ArticleExtractorTest.kt b/src/test/kotlin/com/chimbori/crux/articles/ArticleExtractorTest.kt
@@ -1,3 +1,5 @@
+@file:Suppress("DEPRECATION")
+
 package com.chimbori.crux.articles
 
 import com.chimbori.crux.common.fromFile

diff --git a/src/test/kotlin/com/chimbori/crux/common/TestHelper.kt b/src/test/kotlin/com/chimbori/crux/common/TestHelper.kt
@@ -1,3 +1,5 @@
+@file:Suppress("DEPRECATION")
+
 package com.chimbori.crux.common
 
 import com.chimbori.crux.Crux

diff --git a/src/test/kotlin/com/chimbori/sample/KotlinPublicAPITest.kt b/src/test/kotlin/com/chimbori/sample/KotlinPublicAPITest.kt
@@ -1,3 +1,5 @@
+@file:Suppress("DEPRECATION")
+
 package com.chimbori.sample
 
 import com.chimbori.crux.Crux