Fix some invalid/incomplete javadoc comments

master
jvoisin 6 years ago
parent 7a769d57cf
commit 1640411573
  1. 9
      airsonic-main/src/main/java/org/airsonic/player/ajax/PlayQueueService.java
  2. 4
      airsonic-main/src/main/java/org/airsonic/player/controller/SubsonicRESTController.java
  3. 2
      airsonic-main/src/main/java/org/airsonic/player/dao/UserDao.java
  4. 9
      airsonic-main/src/main/java/org/airsonic/player/monitor/MetricsManager.java
  5. 7
      airsonic-main/src/main/java/org/airsonic/player/service/JukeboxJavaService.java
  6. 4
      airsonic-main/src/main/java/org/airsonic/player/service/SecurityService.java
  7. 6
      airsonic-main/src/test/java/org/airsonic/player/TestCaseUtils.java
  8. 6
      airsonic-main/src/test/java/org/airsonic/player/domain/VersionTestCase.java

@ -462,11 +462,6 @@ public class PlayQueueService {
/**
* 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 {
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.
* @param playQueue
* @param ids
* @return
* @throws Exception
*/
public PlayQueue resetPlayQueue(PlayQueue playQueue,int[] ids, boolean removeVideoFiles) throws Exception {
MediaFile currentFile = playQueue.getCurrentFile();

@ -160,10 +160,6 @@ public class SubsonicRESTController {
/**
* CAUTION : this method is required by mobile applications and must not be removed.
*
* @param request
* @param response
* @throws Exception
*/
@RequestMapping(value = "/getLicense")
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.
*
* @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.
*/
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
* qualified name.
* @param clazz
* @param name
* @return
*/
public Timer timer(Class clazz, String name) {
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
* qualified name.
* @param ref
* @param name
* @return
*/
public Timer timer(Object ref, String name) {
return timer(ref.getClass(),name);
@ -82,9 +76,6 @@ public class MetricsManager {
* Initiate a {@link TimerBuilder} using a condition.
* If the condition is false, a void {@link Timer} will finally be built thus
* no timer will be registered in the Metrics registry.
*
* @param ifTrue
* @return
*/
public TimerBuilder condition(boolean ifTrue) {
if (metricsActivatedByConfiguration()) {

@ -215,8 +215,6 @@ public class JukeboxJavaService {
/**
* Plays the playqueue of a jukebox player starting at the beginning.
*
* @param airsonicPlayer
*/
public void play(Player airsonicPlayer) {
log.debug("begin play jukebox : player = id:{};name:{}", airsonicPlayer.getId(), airsonicPlayer.getName());
@ -295,11 +293,6 @@ public class JukeboxJavaService {
audioPlayer.pause();
}
/**
* @param airsonicPlayer
* @param index
* @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());

@ -135,9 +135,9 @@ public class SecurityService implements UserDetailsService {
/**
* 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
* @return
* @return The corresponding User
*/
public User getUserByName(String username, boolean caseSensitive) {
return userDao.getUserByName(username, caseSensitive);

@ -48,8 +48,6 @@ public class TestCaseUtils {
/**
* Cleans the AIRSONIC_HOME directory used for tests.
*
* @throws IOException
*/
public static void cleanAirsonicHomeForTest() throws IOException {
@ -86,10 +84,6 @@ public class TestCaseUtils {
/**
* Counts records in a table.
*
* @param tableName
* @param daoHelper
* @return
*/
public static Integer recordsInTable(String tableName, DaoHelper daoHelper) {
return daoHelper.getJdbcTemplate().queryForObject("select count(1) from " + tableName,Integer.class);

@ -19,9 +19,9 @@
*/
package org.airsonic.player.domain;
/**
* Unit test of {@link Version}.
* @author Sindre Mehus
/*
Unit test of {@link Version}.
@author Sindre Mehus
*/
import junit.framework.TestCase;

Loading…
Cancel
Save