Add some BibtexNameFomatter comments

JabRef · Feb 6, 2018 · 24ed12a · 24ed12a
1 parent e33bd58
commit 24ed12a
Showing 1 changed file with 10 additions and 5 deletions.
diff --git a/src/main/java/org/jabref/logic/bst/BibtexNameFormatter.java b/src/main/java/org/jabref/logic/bst/BibtexNameFormatter.java
@@ -29,6 +29,15 @@ public class BibtexNameFormatter {
     private BibtexNameFormatter() {
     }
 
+    /**
+     * Formats the nth author of the author name list by a given format string
+     *
+     * @param authorsNameList The string from an author field
+     * @param whichName index of the list, starting with 1
+     * @param formatString TODO
+     * @param warn collects the warnings, may-be-null
+     * @return
+     */
     public static String formatName(String authorsNameList, int whichName, String formatString, Warn warn) {
         AuthorList al = AuthorList.parse(authorsNameList);
 
@@ -40,11 +49,7 @@ public static String formatName(String authorsNameList, int whichName, String fo
     }
 
     /**
-     *
-     * @param author
-     * @param format
-     * @param warn may-be-null
-     * @return
+     * @param warn collects the warnings, may-be-null
      */
     public static String formatName(Author author, String format, Warn warn) {