From 24ed12a69fb5d03464af1c995e679f23366ece34 Mon Sep 17 00:00:00 2001 From: Oliver Kopp Date: Tue, 6 Feb 2018 11:01:28 +0100 Subject: [PATCH] Add some BibtexNameFomatter comments --- .../org/jabref/logic/bst/BibtexNameFormatter.java | 15 ++++++++++----- 1 file changed, 10 insertions(+), 5 deletions(-) diff --git a/src/main/java/org/jabref/logic/bst/BibtexNameFormatter.java b/src/main/java/org/jabref/logic/bst/BibtexNameFormatter.java index 6afe53acbe0..a8b0e1b61c4 100644 --- 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) {