Skip to content

Commit 05c777c

Browse files
committed
[lib] Wrote documentation of code point utility methods
1 parent 66afe4f commit 05c777c

File tree

1 file changed

+25
-1
lines changed

1 file changed

+25
-1
lines changed

tehreer-android/src/main/java/com/mta/tehreer/unicode/CodePoint.java

Lines changed: 25 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,26 +19,50 @@
1919
import com.mta.tehreer.internal.JniBridge;
2020

2121
public class CodePoint {
22-
2322
static {
2423
JniBridge.loadLibrary();
2524
}
2625

2726
private CodePoint() {
2827
}
2928

29+
/**
30+
* Returns the bidirectional class of the specified code point.
31+
*
32+
* @param codePoint The code point whose bidirectional class is returned.
33+
* @return The bidirectional class of the specified code point.
34+
*/
3035
public static int getBidiClass(int codePoint) {
3136
return Unicode.getCodePointBidiClass(codePoint);
3237
}
3338

39+
/**
40+
* Returns the general category of the specified code point.
41+
*
42+
* @param codePoint The code point whose general category is returned.
43+
* @return The general category of the specified code point.
44+
*/
3445
public static int getGeneralCategory(int codePoint) {
3546
return Unicode.getCodePointGeneralCategory(codePoint);
3647
}
3748

49+
/**
50+
* Returns the script of the specified code point.
51+
*
52+
* @param codePoint The code point whose script is returned.
53+
* @return The script of the specified code point.
54+
*/
3855
public static int getScript(int codePoint) {
3956
return Unicode.getCodePointScript(codePoint);
4057
}
4158

59+
/**
60+
* Returns the mirror of the specified code point. If the specified code point does not have a
61+
* mirror, then zero is returned.
62+
*
63+
* @param codePoint The code point whose mirror is returned.
64+
* @return The mirror of the specified code point if available, zero otherwise.
65+
*/
4266
public static int getMirror(int codePoint) {
4367
return Unicode.getCodePointMirror(codePoint);
4468
}

0 commit comments

Comments
 (0)