Fix some invalid/incomplete javadoc comments

This commit is contained in:
jvoisin
2019-06-15 17:15:51 +02:00
parent 7a769d57cf
commit 1640411573
8 changed files with 8 additions and 43 deletions
@@ -462,11 +462,6 @@ public class PlayQueueService {
/** /**
* TODO This method should be moved to a real PlayQueueService not dedicated to Ajax DWR. * TODO This method should be moved to a real PlayQueueService not dedicated to Ajax DWR.
* @param playQueue
* @param ids
* @param index
* @return
* @throws Exception
*/ */
public PlayQueue addMediaFilesToPlayQueue(PlayQueue playQueue,int[] ids, Integer index, boolean removeVideoFiles) throws Exception { public PlayQueue addMediaFilesToPlayQueue(PlayQueue playQueue,int[] ids, Integer index, boolean removeVideoFiles) throws Exception {
List<MediaFile> files = new ArrayList<MediaFile>(ids.length); List<MediaFile> files = new ArrayList<MediaFile>(ids.length);
@@ -498,10 +493,6 @@ public class PlayQueueService {
/** /**
* TODO This method should be moved to a real PlayQueueService not dedicated to Ajax DWR. * TODO This method should be moved to a real PlayQueueService not dedicated to Ajax DWR.
* @param playQueue
* @param ids
* @return
* @throws Exception
*/ */
public PlayQueue resetPlayQueue(PlayQueue playQueue,int[] ids, boolean removeVideoFiles) throws Exception { public PlayQueue resetPlayQueue(PlayQueue playQueue,int[] ids, boolean removeVideoFiles) throws Exception {
MediaFile currentFile = playQueue.getCurrentFile(); MediaFile currentFile = playQueue.getCurrentFile();
@@ -160,10 +160,6 @@ public class SubsonicRESTController {
/** /**
* CAUTION : this method is required by mobile applications and must not be removed. * CAUTION : this method is required by mobile applications and must not be removed.
*
* @param request
* @param response
* @throws Exception
*/ */
@RequestMapping(value = "/getLicense") @RequestMapping(value = "/getLicense")
public void getLicense(HttpServletRequest request, HttpServletResponse response) throws Exception { public void getLicense(HttpServletRequest request, HttpServletResponse response) throws Exception {
@@ -79,7 +79,7 @@ public class UserDao extends AbstractDao {
* Returns the user with the given username. * Returns the user with the given username.
* *
* @param username The username used when logging in. * @param username The username used when logging in.
* @param caseSensitive * @param caseSensitive If false, perform a case-insensitive search
* @return The user, or <code>null</code> if not found. * @return The user, or <code>null</code> if not found.
*/ */
public User getUserByName(String username, boolean caseSensitive) { public User getUserByName(String username, boolean caseSensitive) {
@@ -55,9 +55,6 @@ public class MetricsManager {
/** /**
* Creates a {@link Timer} whose name is based on a class name and a * Creates a {@link Timer} whose name is based on a class name and a
* qualified name. * qualified name.
* @param clazz
* @param name
* @return
*/ */
public Timer timer(Class clazz, String name) { public Timer timer(Class clazz, String name) {
if (metricsActivatedByConfiguration()) { if (metricsActivatedByConfiguration()) {
@@ -70,9 +67,6 @@ public class MetricsManager {
/** /**
* Creates a {@link Timer} whose name is based on an object's class name and a * Creates a {@link Timer} whose name is based on an object's class name and a
* qualified name. * qualified name.
* @param ref
* @param name
* @return
*/ */
public Timer timer(Object ref, String name) { public Timer timer(Object ref, String name) {
return timer(ref.getClass(),name); return timer(ref.getClass(),name);
@@ -82,9 +76,6 @@ public class MetricsManager {
* Initiate a {@link TimerBuilder} using a condition. * Initiate a {@link TimerBuilder} using a condition.
* If the condition is false, a void {@link Timer} will finally be built thus * If the condition is false, a void {@link Timer} will finally be built thus
* no timer will be registered in the Metrics registry. * no timer will be registered in the Metrics registry.
*
* @param ifTrue
* @return
*/ */
public TimerBuilder condition(boolean ifTrue) { public TimerBuilder condition(boolean ifTrue) {
if (metricsActivatedByConfiguration()) { if (metricsActivatedByConfiguration()) {
@@ -215,8 +215,6 @@ public class JukeboxJavaService {
/** /**
* Plays the playqueue of a jukebox player starting at the beginning. * Plays the playqueue of a jukebox player starting at the beginning.
*
* @param airsonicPlayer
*/ */
public void play(Player airsonicPlayer) { public void play(Player airsonicPlayer) {
log.debug("begin play jukebox : player = id:{};name:{}", airsonicPlayer.getId(), airsonicPlayer.getName()); log.debug("begin play jukebox : player = id:{};name:{}", airsonicPlayer.getId(), airsonicPlayer.getName());
@@ -295,11 +293,6 @@ public class JukeboxJavaService {
audioPlayer.pause(); audioPlayer.pause();
} }
/**
* @param airsonicPlayer
* @param index
* @throws Exception
*/
public void skip(Player airsonicPlayer, int index, int offset) throws Exception { public void skip(Player airsonicPlayer, int index, int offset) throws Exception {
log.debug("begin skip jukebox : player = id:{};name:{}", airsonicPlayer.getId(), airsonicPlayer.getName()); log.debug("begin skip jukebox : player = id:{};name:{}", airsonicPlayer.getId(), airsonicPlayer.getName());
@@ -135,9 +135,9 @@ public class SecurityService implements UserDetailsService {
/** /**
* Returns the user with the given username * Returns the user with the given username
* @param username * @param username The username to look for
* @param caseSensitive If false, will do a case insensitive search * @param caseSensitive If false, will do a case insensitive search
* @return * @return The corresponding User
*/ */
public User getUserByName(String username, boolean caseSensitive) { public User getUserByName(String username, boolean caseSensitive) {
return userDao.getUserByName(username, caseSensitive); return userDao.getUserByName(username, caseSensitive);
@@ -48,9 +48,7 @@ public class TestCaseUtils {
/** /**
* Cleans the AIRSONIC_HOME directory used for tests. * Cleans the AIRSONIC_HOME directory used for tests.
* */
* @throws IOException
*/
public static void cleanAirsonicHomeForTest() throws IOException { public static void cleanAirsonicHomeForTest() throws IOException {
File airsonicHomeDir = new File(airsonicHomePathForTest()); File airsonicHomeDir = new File(airsonicHomePathForTest());
@@ -86,11 +84,7 @@ public class TestCaseUtils {
/** /**
* Counts records in a table. * Counts records in a table.
* */
* @param tableName
* @param daoHelper
* @return
*/
public static Integer recordsInTable(String tableName, DaoHelper daoHelper) { public static Integer recordsInTable(String tableName, DaoHelper daoHelper) {
return daoHelper.getJdbcTemplate().queryForObject("select count(1) from " + tableName,Integer.class); return daoHelper.getJdbcTemplate().queryForObject("select count(1) from " + tableName,Integer.class);
} }
@@ -19,9 +19,9 @@
*/ */
package org.airsonic.player.domain; package org.airsonic.player.domain;
/** /*
* Unit test of {@link Version}. Unit test of {@link Version}.
* @author Sindre Mehus @author Sindre Mehus
*/ */
import junit.framework.TestCase; import junit.framework.TestCase;