From f887cb132bd6ee3be43e1a7ebfee52c3ac113f3a Mon Sep 17 00:00:00 2001 From: Drakeet Date: Sat, 29 Feb 2020 21:05:42 +0800 Subject: [PATCH] Add java doc notes for the useCompat --- .../java/io/noties/markwon/linkify/LinkifyPlugin.java | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/markwon-linkify/src/main/java/io/noties/markwon/linkify/LinkifyPlugin.java b/markwon-linkify/src/main/java/io/noties/markwon/linkify/LinkifyPlugin.java index b1bf826a..47347ed3 100644 --- a/markwon-linkify/src/main/java/io/noties/markwon/linkify/LinkifyPlugin.java +++ b/markwon-linkify/src/main/java/io/noties/markwon/linkify/LinkifyPlugin.java @@ -38,6 +38,11 @@ public class LinkifyPlugin extends AbstractMarkwonPlugin { return create(false); } + /** + * @param useCompat If true, use {@link LinkifyCompat} to handle links. + * Note that the {@link LinkifyCompat} depends on androidx.core:core, + * the dependency must be added on a client side explicitly. + */ @NonNull public static LinkifyPlugin create(boolean useCompat) { return create(Linkify.EMAIL_ADDRESSES | Linkify.PHONE_NUMBERS | Linkify.WEB_URLS, useCompat); @@ -48,6 +53,11 @@ public class LinkifyPlugin extends AbstractMarkwonPlugin { return new LinkifyPlugin(mask, false); } + /** + * @param useCompat If true, use {@link LinkifyCompat} to handle links. + * Note that the {@link LinkifyCompat} depends on androidx.core:core, + * the dependency must be added on a client side explicitly. + */ @NonNull public static LinkifyPlugin create(@LinkifyMask int mask, boolean useCompat) { return new LinkifyPlugin(mask, useCompat);