From e8a78182b8d0f2b4697fc70caf1cbe5d3c3e8f2c Mon Sep 17 00:00:00 2001
From: johnniang <johnniang@riseup.net>
Date: Tue, 2 Apr 2019 22:55:17 +0800
Subject: [PATCH] Add some comments on FilenameUtils

---
 .../cc/ryanc/halo/utils/FilenameUtils.java    | 20 +++++++++++++++++++
 1 file changed, 20 insertions(+)

diff --git a/src/main/java/cc/ryanc/halo/utils/FilenameUtils.java b/src/main/java/cc/ryanc/halo/utils/FilenameUtils.java
index 1d7c2a726..31b10e30a 100644
--- a/src/main/java/cc/ryanc/halo/utils/FilenameUtils.java
+++ b/src/main/java/cc/ryanc/halo/utils/FilenameUtils.java
@@ -17,6 +17,15 @@ public class FilenameUtils {
     private FilenameUtils() {
     }
 
+    /**
+     * Gets base name of file name. <br>
+     * eg: <br>
+     * filename: /home/test/test.txt <br>
+     * basename: test
+     *
+     * @param filename filename must not be blank
+     * @return basename of the given file name
+     */
     @NonNull
     public static String getBasename(@NonNull String filename) {
         Assert.hasText(filename, "Filename must not be blank");
@@ -42,6 +51,17 @@ public class FilenameUtils {
         return filename.substring(0, dotLastIndex);
     }
 
+    /**
+     * Gets extension of the file name. <br>
+     * <code>
+     * eg: <br>
+     * filename: /home/test/test.txt <br>
+     * extension: txt
+     * </code>
+     *
+     * @param filename filename must not be blank
+     * @return an extension of the given file name
+     */
     @NonNull
     public static String getExtension(@NonNull String filename) {
         Assert.hasText(filename, "Filename must not be blank");