Fix some javadoc comments

- Remove a dangling comment
- Delete half-documented parameters
- Fix some @see/@link

Signed-off-by: Andrew DeMaria <lostonamountain@gmail.com>
This commit is contained in:
jvoisin
2019-10-06 15:37:54 -06:00
committed by Andrew DeMaria
parent 889add6848
commit dddf8dc0aa
7 changed files with 3 additions and 27 deletions
@@ -129,7 +129,6 @@ public class InternetRadioService {
*
* @param radio an internet radio
* @return a list of internet radio sources
* @throws Exception
*/
private List<InternetRadioSource> retrieveInternetRadioSources(InternetRadio radio) throws Exception {
return retrieveInternetRadioSources(
@@ -148,7 +147,6 @@ public class InternetRadioService {
* @param maxByteSize maximum size of the response, in bytes, or 0 if unlimited
* @param maxRedirects maximum number of redirects, or 0 if unlimited
* @return a list of internet radio sources
* @throws Exception
*/
private List<InternetRadioSource> retrieveInternetRadioSources(InternetRadio radio, int maxCount, long maxByteSize, int maxRedirects) throws Exception {
// Retrieve the remote playlist
@@ -163,12 +163,6 @@ public class IndexManager {
}
}
/**
*
* @param indexType
* @return
* @throws IOException
*/
private IndexWriter createIndexWriter(IndexType indexType) throws IOException {
File indexDirectory = getIndexDirectory.apply(indexType);
IndexWriterConfig config = new IndexWriterConfig(analyzerFactory.getAnalyzer());
@@ -234,7 +228,6 @@ public class IndexManager {
/**
* Close Writer of specified index and refresh SearcherManager.
* @param type
*/
private void stopIndexing(IndexType type) {
@@ -268,9 +261,6 @@ public class IndexManager {
* Return the IndexSearcher of the specified index.
* At initial startup, it may return null
* if the user performs any search before performing a scan.
*
* @param indexType
* @return
*/
public @Nullable IndexSearcher getSearcher(IndexType indexType) {
if (!searchers.containsKey(indexType)) {
@@ -91,7 +91,6 @@ public enum IndexType {
*
* @param k Field name defined by FieldNames
* @param v Boost value
* @return
*/
private static final SimpleEntry<String, Float> entry(String k, float v) {
return new AbstractMap.SimpleEntry<>(k, v);
@@ -101,9 +100,6 @@ public enum IndexType {
* Defines the field that the input value is to search for
* when searching IndexType.
* If you specify multiple values, list the field names.
*
* @param names
* @return
*/
private static final String[] fieldNames(String... names) {
return Arrays.stream(names).toArray(String[]::new);
@@ -123,7 +119,7 @@ public enum IndexType {
*
* @return Map of fields and boost values
* @since legacy
* @see BoostQuery
* @see org.apache.lucene.search.BoostQuery
*/
public Map<String, Float> getBoosts() {
return boosts;
@@ -184,10 +184,6 @@ public class QueryFactory {
/**
* Query generation expression extracted from
* {@link org.airsonic.player.service.SearchService#getRandomSongs(RandomSearchCriteria)}.
*
* @param criteria criteria
* @return Query
* @throws IOException
*/
public Query getRandomSongs(RandomSearchCriteria criteria) throws IOException {
@@ -95,11 +95,7 @@ public class SearchServiceImpl implements SearchService {
* Common processing of random method.
*
* @param count Number of albums to return.
* @param searcher
* @param query
* @param id2ListCallBack Callback to get D from id and store it in List
* @return result
* @throws IOException
*/
private final <D> List<D> createRandomDocsList(
int count, IndexSearcher searcher, Query query, BiConsumer<List<D>, Integer> id2ListCallBack)
@@ -29,7 +29,7 @@ import org.springframework.test.context.junit4.rules.SpringMethodRule;
"/applicationContext-testdb.xml"})
@DirtiesContext(classMode = DirtiesContext.ClassMode.AFTER_CLASS)
@Component
/**
/*
* Abstract class for scanning MusicFolder.
*/
public abstract class AbstractAirsonicHomeTest implements AirsonicHomeTest {
@@ -156,7 +156,7 @@ public class AnalyzerFactoryTestCase {
/**
* Detailed tests on Stopward.
*
* @see org.apache.lucene.analysis.StopAnalyzer#ENGLISH_STOP_WORDS_SET
* @see org.apache.lucene.analysis.core.StopAnalyzer#ENGLISH_STOP_WORDS_SET
*/
@Test
public void testStopward() {