docs: add annotation for RegexUtils#parseEpisodeSeqByFileName (#626)

ikaros-dev · Jul 16, 2024 · 1be0bd7 · 1be0bd7
1 parent 4d3f03b
commit 1be0bd7
Showing 1 changed file with 7 additions and 0 deletions.
diff --git a/api/src/main/java/run/ikaros/api/infra/utils/RegexUtils.java b/api/src/main/java/run/ikaros/api/infra/utils/RegexUtils.java
@@ -292,6 +292,13 @@ public static String getMatchingChineseStrWithoutTag(String str) {
 
     /**
      * Parse episode seq by file name.
+     * <ul>
+     *     <li>getFileNameBlankEpSeq: xxxx 04 xxxx. mp4 => 04 .</li>
+     *     <li>getFileNameTagEpSeq: xxxxxxx[02] xxxxxx. mp4 => 02 .</li>
+     *     <li>getEpFileNameIntegrallySeq: xxxx EP04 xxxx. mp4 => 04 .</li>
+     *     <li>getFileNameHorizontalEpSeq: xxxx-04-xxxx. mp4 => 04 .</li>
+     *     <li>getFileNameUnderlineEpSeq: xxxx_04_xxxx. mp4 => 04 .</li>
+     * </ul>
      */
     @Nonnull
     public static Long parseEpisodeSeqByFileName(String fileName) {