the-btfash-foundation/Markwon
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Add java doc notes for the useCompat

Browse Source
This commit is contained in:
Drakeet 2020-02-29 21:05:42 +08:00
parent d7f52607ab
commit f887cb132b
1 changed files with 10 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
markwon-linkify/src/main/java/io/noties/markwon/linkify/LinkifyPlugin.java
View File

@ -38,6 +38,11 @@ public class LinkifyPlugin extends AbstractMarkwonPlugin {
return create(false); 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 @NonNull
public static LinkifyPlugin create(boolean useCompat) { public static LinkifyPlugin create(boolean useCompat) {
return create(Linkify.EMAIL_ADDRESSES | Linkify.PHONE_NUMBERS | Linkify.WEB_URLS, 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); 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 @NonNull
public static LinkifyPlugin create(@LinkifyMask int mask, boolean useCompat) { public static LinkifyPlugin create(@LinkifyMask int mask, boolean useCompat) {
return new LinkifyPlugin(mask, useCompat); return new LinkifyPlugin(mask, useCompat);