From 3ced06c7314ebf68ee6115c2f9f9e9e0554bf6ee Mon Sep 17 00:00:00 2001 From: Daleth Darko Date: Wed, 26 Jan 2022 11:22:43 +0100 Subject: [PATCH] Various javadoc fixes --- .../net/yacy/cora/bayes/BayesClassifier.java | 2 +- source/net/yacy/cora/document/WordCache.java | 8 ++++---- .../AbstractFederateSearchConnector.java | 4 ++-- .../federate/opensearch/SRURSSConnector.java | 3 ++- .../cora/federate/solr/SchemaDeclaration.java | 2 +- .../solr/connector/AbstractSolrConnector.java | 4 ++-- .../federate/solr/connector/SolrConnector.java | 6 +++--- .../solr/connector/SolrServerConnector.java | 2 +- .../responsewriter/YJsonResponseWriter.java | 3 +-- .../net/yacy/cora/protocol/ResponseHeader.java | 2 +- .../net/yacy/cora/protocol/TimeoutRequest.java | 3 ++- .../yacy/cora/sorting/AbstractScoreMap.java | 1 - source/net/yacy/cora/sorting/ScoreMap.java | 1 - source/net/yacy/crawler/Balancer.java | 3 ++- source/net/yacy/crawler/data/Snapshots.java | 1 - source/net/yacy/crawler/data/Transactions.java | 3 +-- source/net/yacy/crawler/retrieval/Request.java | 3 ++- source/net/yacy/crawler/robots/RobotsTxt.java | 2 +- source/net/yacy/data/BookmarksDB.java | 2 +- source/net/yacy/data/UserDB.java | 2 +- source/net/yacy/data/wiki/WikiCode.java | 2 +- source/net/yacy/document/TextParser.java | 6 +++--- .../net/yacy/document/parser/bzipParser.java | 2 +- .../net/yacy/document/parser/html/Scraper.java | 2 +- source/net/yacy/document/parser/tarParser.java | 2 +- .../yacy/http/servlets/YaCyDefaultServlet.java | 2 +- .../net/yacy/kelondro/blob/BEncodedHeap.java | 18 +++++++++--------- source/net/yacy/kelondro/blob/Stack.java | 2 +- source/net/yacy/kelondro/blob/Stacks.java | 5 +++-- .../yacy/kelondro/blob/TablesColumnIndex.java | 1 - .../kelondro/data/word/WordReferenceVars.java | 2 +- .../net/yacy/kelondro/index/RowHandleMap.java | 9 ++++++--- source/net/yacy/kelondro/index/RowSet.java | 6 +++--- .../yacy/peers/graphics/WebStructureGraph.java | 2 +- .../net/yacy/repository/BlacklistHelper.java | 2 -- .../search/schema/WebgraphConfiguration.java | 2 +- .../net/yacy/search/snippet/TextSnippet.java | 2 +- source/net/yacy/server/serverClassLoader.java | 2 +- source/net/yacy/server/serverSwitch.java | 2 +- .../net/yacy/utils/SignatureOutputStream.java | 3 ++- .../utils/translation/TranslationManager.java | 2 +- .../utils/translation/TranslatorXliff.java | 8 ++++---- 42 files changed, 71 insertions(+), 70 deletions(-) diff --git a/source/net/yacy/cora/bayes/BayesClassifier.java b/source/net/yacy/cora/bayes/BayesClassifier.java index 7704f60ee..8085a10a1 100644 --- a/source/net/yacy/cora/bayes/BayesClassifier.java +++ b/source/net/yacy/cora/bayes/BayesClassifier.java @@ -47,7 +47,7 @@ import java.util.TreeSet; * * @author Philipp Nolte * - * @see http://en.wikipedia.org/wiki/Naive_Bayes_classifier + * @see Naive Bayes classifier * * @param The feature class. * @param The category class. diff --git a/source/net/yacy/cora/document/WordCache.java b/source/net/yacy/cora/document/WordCache.java index 491d30cd2..968a30abf 100644 --- a/source/net/yacy/cora/document/WordCache.java +++ b/source/net/yacy/cora/document/WordCache.java @@ -99,7 +99,7 @@ public class WordCache { /** * read the dictionary and construct a set of recommendations to a given string - * @param s input value that is used to match recommendations + * @param string input value that is used to match recommendations * @return set that contains all words that start or end with the input value */ public Set recommend(StringBuilder string) { @@ -139,7 +139,7 @@ public class WordCache { * check if the library supports the given word * A word is supported, if the library contains a word * that starts or ends with the given word - * @param s the given word + * @param string the given word * @return true if the library supports the word */ public boolean supports(StringBuilder string) { @@ -259,7 +259,7 @@ public class WordCache { /** * read the dictionary and construct a set of recommendations to a given string - * @param s input value that is used to match recommendations + * @param string input value that is used to match recommendations * @return set that contains all words that start or end with the input value */ public Set recommend(StringBuilder string) { @@ -302,7 +302,7 @@ public class WordCache { * check if the library supports the given word * A word is supported, if the library contains a word * that starts or ends with the given word - * @param s the given word + * @param string the given word * @return true if the library supports the word */ public boolean supports(StringBuilder string) { diff --git a/source/net/yacy/cora/federate/AbstractFederateSearchConnector.java b/source/net/yacy/cora/federate/AbstractFederateSearchConnector.java index 9f37d60b3..71bce0950 100644 --- a/source/net/yacy/cora/federate/AbstractFederateSearchConnector.java +++ b/source/net/yacy/cora/federate/AbstractFederateSearchConnector.java @@ -82,7 +82,7 @@ public abstract class AbstractFederateSearchConnector implements FederateSearchC * convert the remote serch result to the internal result presentation * (field mapping) * - * @param instanceName internal name + * @param instance internal name * @param cfgFileName e.g. DATA/SETTINGS/FEDERATECFG/instanceName.SCHEMA * @return true if success false if not */ @@ -156,7 +156,7 @@ public abstract class AbstractFederateSearchConnector implements FederateSearchC * Converts a remote schema result to YaCy schema using the fieldname * mapping provided as config file * - * @param remote result (with remote fieldnames) + * @param doc result (with remote fieldnames) * @return SolrDocument with field names according to the YaCy schema */ protected URIMetadataNode toYaCySchema(final SolrDocument doc) throws MalformedURLException { diff --git a/source/net/yacy/cora/federate/opensearch/SRURSSConnector.java b/source/net/yacy/cora/federate/opensearch/SRURSSConnector.java index 2f2892267..a8e1ebb15 100644 --- a/source/net/yacy/cora/federate/opensearch/SRURSSConnector.java +++ b/source/net/yacy/cora/federate/opensearch/SRURSSConnector.java @@ -91,8 +91,9 @@ public class SRURSSConnector { * @param query the query as string * @param startRecord number of first record * @param maximumRecords maximum number of records - * @param verify if true, result entries are verified using the snippet fetch (slow); if false simply the result is returned + * @param cacheStrategy * @param global if true also search results from other peers are included + * @param agent * @return */ public static RSSFeed loadSRURSS( diff --git a/source/net/yacy/cora/federate/solr/SchemaDeclaration.java b/source/net/yacy/cora/federate/solr/SchemaDeclaration.java index 12ced9e77..94767e64c 100644 --- a/source/net/yacy/cora/federate/solr/SchemaDeclaration.java +++ b/source/net/yacy/cora/federate/solr/SchemaDeclaration.java @@ -52,7 +52,7 @@ public interface SchemaDeclaration { /** * @return true when this field is stored as a column-oriented field optimized for sorting, faceting and grouping - * @see https://cwiki.apache.org/confluence/display/solr/DocValues + * @see DocValues */ public boolean isDocValue(); diff --git a/source/net/yacy/cora/federate/solr/connector/AbstractSolrConnector.java b/source/net/yacy/cora/federate/solr/connector/AbstractSolrConnector.java index 90dc47859..b284e876c 100644 --- a/source/net/yacy/cora/federate/solr/connector/AbstractSolrConnector.java +++ b/source/net/yacy/cora/federate/solr/connector/AbstractSolrConnector.java @@ -333,7 +333,7 @@ public abstract class AbstractSolrConnector implements SolrConnector { * get a document id result stream from a set of solr queries. * The result queue is considered as terminated if AbstractSolrConnector.POISON_ID is returned. * The method returns immediately and feeds the search results into the queue - * @param querystring a list of query strings + * @param querystrings a list of query strings * @param sort the solr sort string, may be null to be not used * @param offset common offset of all queries * @param maxcount maximum count for each query @@ -610,7 +610,7 @@ public abstract class AbstractSolrConnector implements SolrConnector { * Update a collection of solr input documents. * This will write only a partial update for all fields given in the SolrInputDocuments * and leaves all other fields untouched. - * @param solrdocs + * @param solrdoc * @throws IOException * @throws SolrException */ diff --git a/source/net/yacy/cora/federate/solr/connector/SolrConnector.java b/source/net/yacy/cora/federate/solr/connector/SolrConnector.java index ef2a61ad5..a0de17230 100644 --- a/source/net/yacy/cora/federate/solr/connector/SolrConnector.java +++ b/source/net/yacy/cora/federate/solr/connector/SolrConnector.java @@ -143,7 +143,7 @@ public interface SolrConnector extends Iterable /* Iterable of document /** * add a collection of solr input documents - * @param solrdocs + * @param solrdoc * @throws IOException * @throws SolrException */ @@ -153,7 +153,7 @@ public interface SolrConnector extends Iterable /* Iterable of document * Update a collection of solr input documents. * This will write only a partial update for all fields given in the SolrInputDocuments * and leaves all other fields untouched. - * @param solrdocs + * @param solrdoc * @throws IOException * @throws SolrException */ @@ -321,7 +321,7 @@ public interface SolrConnector extends Iterable /* Iterable of document * get a document id result stream from a set of solr queries. * The result queue is considered as terminated if AbstractSolrConnector.POISON_ID is returned. * The method returns immediately and feeds the search results into the queue - * @param querystring a list of query strings + * @param querystrings a list of query strings * @param sort the solr sort string, may be null to be not used * @param offset common offset of all queries * @param maxcount maximum count for each query diff --git a/source/net/yacy/cora/federate/solr/connector/SolrServerConnector.java b/source/net/yacy/cora/federate/solr/connector/SolrServerConnector.java index f201e8f42..de0ecc351 100644 --- a/source/net/yacy/cora/federate/solr/connector/SolrServerConnector.java +++ b/source/net/yacy/cora/federate/solr/connector/SolrServerConnector.java @@ -172,7 +172,7 @@ public abstract class SolrServerConnector extends AbstractSolrConnector implemen /** * delete entries from solr according the given solr query string - * @param id the url hash of the entry + * @param querystring * @throws IOException */ @Override diff --git a/source/net/yacy/cora/federate/solr/responsewriter/YJsonResponseWriter.java b/source/net/yacy/cora/federate/solr/responsewriter/YJsonResponseWriter.java index b9957fa54..9ff2da1bc 100644 --- a/source/net/yacy/cora/federate/solr/responsewriter/YJsonResponseWriter.java +++ b/source/net/yacy/cora/federate/solr/responsewriter/YJsonResponseWriter.java @@ -118,7 +118,7 @@ public class YJsonResponseWriter implements QueryResponseWriter, SolrjResponseWr * @param writer an open output writer. Must not be null. * @param request the initial Solr request. Must not be null. * @param values the response values. Must not be null. - * @param rsp the Solr response header. + * @param responseObj the Solr response header. * @throws IOException when a write error occurred */ private void write(final Writer writer, final SolrQueryRequest request, final NamedList values, @@ -375,7 +375,6 @@ public class YJsonResponseWriter implements QueryResponseWriter, SolrjResponseWr * * @param writer an open output writer. Must not be null. * @param documents the documents to render. Must not be null. - * @param responseCount the number of documents to process * @param snippets snippets Solr computed text snippets (highlighting). * @throws IOException when an unexpected error occurred while writing */ diff --git a/source/net/yacy/cora/protocol/ResponseHeader.java b/source/net/yacy/cora/protocol/ResponseHeader.java index ca5a07ab3..9ae002d13 100644 --- a/source/net/yacy/cora/protocol/ResponseHeader.java +++ b/source/net/yacy/cora/protocol/ResponseHeader.java @@ -146,7 +146,7 @@ public class ResponseHeader extends HeaderFramework { * @param path Path the cookie belongs to. Default - "/". Can be null. * @param domain Domain this cookie belongs to. Default - domain name. Can be null. * @param secure If true cookie will be send only over safe connection such as https - * @see further documentation: docs.sun.com + * @see further documentation at docs.sun.com */ public void setCookie(final String name, final String value, final Integer maxage, final String path, final String domain, final boolean secure) { diff --git a/source/net/yacy/cora/protocol/TimeoutRequest.java b/source/net/yacy/cora/protocol/TimeoutRequest.java index 27ade24c5..8b57e07a7 100644 --- a/source/net/yacy/cora/protocol/TimeoutRequest.java +++ b/source/net/yacy/cora/protocol/TimeoutRequest.java @@ -114,7 +114,8 @@ public class TimeoutRequest { /** * ping a remote server using a given uri and a time-out - * @param uri + * @param host + * @param port * @param timeout * @return true if the server exists and replies within the given time-out */ diff --git a/source/net/yacy/cora/sorting/AbstractScoreMap.java b/source/net/yacy/cora/sorting/AbstractScoreMap.java index 84b318cd2..b662925a1 100644 --- a/source/net/yacy/cora/sorting/AbstractScoreMap.java +++ b/source/net/yacy/cora/sorting/AbstractScoreMap.java @@ -46,7 +46,6 @@ public abstract class AbstractScoreMap implements ScoreMap { /** * divide the map into two halve parts using the count of the entries - * @param score * @return the objects of the smaller entries from at least 1/2 of the list */ @Override diff --git a/source/net/yacy/cora/sorting/ScoreMap.java b/source/net/yacy/cora/sorting/ScoreMap.java index 231dccc10..52d3a7407 100644 --- a/source/net/yacy/cora/sorting/ScoreMap.java +++ b/source/net/yacy/cora/sorting/ScoreMap.java @@ -49,7 +49,6 @@ public interface ScoreMap extends Iterable { /** * divide the map into two halve parts using the count of the entries - * @param score * @return the objects of the smaller entries from at least 1/2 of the list */ public List lowerHalf(); diff --git a/source/net/yacy/crawler/Balancer.java b/source/net/yacy/crawler/Balancer.java index 4e89947cd..9d106ad46 100644 --- a/source/net/yacy/crawler/Balancer.java +++ b/source/net/yacy/crawler/Balancer.java @@ -132,7 +132,8 @@ public interface Balancer { * the necessary time until the url is released and returned as CrawlEntry object. In case that a profile * for the computed Entry does not exist, null is returned * @param delay true if the requester demands forced delays using explicit thread sleep - * @param profile + * @param cs + * @param robots * @return a url in a CrawlEntry object * @throws IOException * @throws SpaceExceededException diff --git a/source/net/yacy/crawler/data/Snapshots.java b/source/net/yacy/crawler/data/Snapshots.java index a60e5a206..f5dd411a8 100644 --- a/source/net/yacy/crawler/data/Snapshots.java +++ b/source/net/yacy/crawler/data/Snapshots.java @@ -274,7 +274,6 @@ public class Snapshots { * The actual deletion of files in the target directory must be done elsewhere, this method does not store the snapshot files. * @param url * @param depth - * @param date */ public Set announceDeletion(final DigestURL url, final int depth) { HashSet dates = new HashSet<>(); diff --git a/source/net/yacy/crawler/data/Transactions.java b/source/net/yacy/crawler/data/Transactions.java index b7b3b22db..14969b852 100644 --- a/source/net/yacy/crawler/data/Transactions.java +++ b/source/net/yacy/crawler/data/Transactions.java @@ -83,7 +83,7 @@ public class Transactions { /** * @param dir the parent directory of inventory and archive snapshots. - * @param wkhtmltopdfTimeout the maximum to wait for each wkhtmltopdf call when rendering PDF snapshots + * @param wkhtmltopdfSecondsTimeout the maximum to wait for each wkhtmltopdf call when rendering PDF snapshots */ public static void init(final File dir, final long wkhtmltopdfSecondsTimeout) { transactionDir = dir; @@ -361,7 +361,6 @@ public class Transactions { * @param state the wanted transaction state, State.INVENTORY, State.ARCHIVE or State.ANY * @param url * @param depth - * @param date */ public static void announceDeletion(final DigestURL url, final int depth, final State state) { if (state == State.INVENTORY || state == State.ANY) inventory.announceDeletion(url, depth); diff --git a/source/net/yacy/crawler/retrieval/Request.java b/source/net/yacy/crawler/retrieval/Request.java index 3bff0d640..41e958687 100644 --- a/source/net/yacy/crawler/retrieval/Request.java +++ b/source/net/yacy/crawler/retrieval/Request.java @@ -29,6 +29,7 @@ package net.yacy.crawler.retrieval; import java.io.IOException; +import java.net.URL; import java.util.Date; import net.yacy.cora.document.encoding.ASCII; @@ -127,7 +128,7 @@ public class Request extends WorkflowJob * * @param initiator the hash of the initiator peer * @param url the {@link URL} to crawl - * @param referrer the hash of the referrer URL + * @param referrerhash the hash of the referrer URL * @param name the name of the document to crawl * @param appdate the time when the url was first time appeared * @param profileHandle the name of the prefetch profile. This must not be null! diff --git a/source/net/yacy/crawler/robots/RobotsTxt.java b/source/net/yacy/crawler/robots/RobotsTxt.java index 16b9cf08b..2035e961c 100644 --- a/source/net/yacy/crawler/robots/RobotsTxt.java +++ b/source/net/yacy/crawler/robots/RobotsTxt.java @@ -82,7 +82,7 @@ public class RobotsTxt { * * @param worktables * @param loader - * @param maxConcurrentTheads maximum active threads this instance is allowed to run for its concurrent tasks + * @param maxActiveTheads maximum active threads this instance is allowed to run for its concurrent tasks */ public RobotsTxt(final WorkTables worktables, LoaderDispatcher loader, final int maxActiveTheads) { this.threadPool = new ThreadPoolExecutor(maxActiveTheads, maxActiveTheads, diff --git a/source/net/yacy/data/BookmarksDB.java b/source/net/yacy/data/BookmarksDB.java index 1f91ca92b..fd5854925 100644 --- a/source/net/yacy/data/BookmarksDB.java +++ b/source/net/yacy/data/BookmarksDB.java @@ -639,7 +639,7 @@ public class BookmarksDB { /** * set the Tags of the bookmark - * @param tagNames ArrayList with the tagnames + * @param tags2 ArrayList with the tagnames * @param local sets, whether the updated tags should be stored to tagsDB */ public void setTags(final Set tags2, final boolean local){ diff --git a/source/net/yacy/data/UserDB.java b/source/net/yacy/data/UserDB.java index 6906b7fbd..ae0f0511c 100644 --- a/source/net/yacy/data/UserDB.java +++ b/source/net/yacy/data/UserDB.java @@ -196,7 +196,7 @@ public final class UserDB { * Determine if a user has admin rights from a 'Authorisation' http header field. * Tests both userDB and old style adminpw. * - * @param auth http-headerline for authorisation. + * @param header http-headerline for authorisation. * @param cookies */ public boolean hasAdminRight(final RequestHeader header, final Cookie[] cookies) { diff --git a/source/net/yacy/data/wiki/WikiCode.java b/source/net/yacy/data/wiki/WikiCode.java index f7b1f2bf4..2851b31bc 100644 --- a/source/net/yacy/data/wiki/WikiCode.java +++ b/source/net/yacy/data/wiki/WikiCode.java @@ -1051,7 +1051,7 @@ public class WikiCode extends AbstractWikiParser implements WikiParser { * Process template inclusions in line, eventually with geo coordinate metadata * @param line line of wiki text * @return cleaned text with eventual geo coordinates formatted to be recognizable by parser - * @see https://en.wikipedia.org/wiki/Wikipedia:Transclusion + * @see Wikipedia:Transclusion */ protected static String processMetadata(final String line) { StringBuilder processedLine = new StringBuilder(line); diff --git a/source/net/yacy/document/TextParser.java b/source/net/yacy/document/TextParser.java index de1486392..7529b72ec 100644 --- a/source/net/yacy/document/TextParser.java +++ b/source/net/yacy/document/TextParser.java @@ -418,7 +418,7 @@ public final class TextParser { * @param timezoneOffset the local time zone offset * @param depth the current depth of the crawl * @param contentLength the length of the source, if known (else -1 should be used) - * @param source a input stream + * @param sourceStream a input stream * @param maxLinks the maximum total number of links to parse and add to the result documents * @param maxBytes the maximum number of content bytes to process * @return a list of documents that result from parsing the source, with empty or null text. @@ -443,7 +443,7 @@ public final class TextParser { * @param timezoneOffset the local time zone offset * @param depth the current depth of the crawl * @param contentLength the length of the source, if known (else -1 should be used) - * @param source a input stream + * @param sourceStream a input stream * @param maxLinks the maximum total number of links to parse and add to the result documents * @param maxBytes the maximum number of content bytes to process * @return a list of documents that result from parsing the source, with empty or null text. @@ -665,7 +665,7 @@ public final class TextParser { * - the mime type computed from the extension (3.) * finally the generic parser is added as backup if all above fail * @param url the given url - * @param mimeType the given mime type + * @param mimeType1 the given mime type * @return a list of Idiom parsers that may be appropriate for the given criteria * @throws Parser.Failure when the file extension or the MIME type is denied */ diff --git a/source/net/yacy/document/parser/bzipParser.java b/source/net/yacy/document/parser/bzipParser.java index 7a0eb8b88..15a63a41b 100644 --- a/source/net/yacy/document/parser/bzipParser.java +++ b/source/net/yacy/document/parser/bzipParser.java @@ -148,7 +148,7 @@ public class bzipParser extends AbstractParser implements Parser { * @param location the parsed resource URL * @param mimeType the media type of the resource * @param charset the charset name if known - * @param an instance of bzipParser that is registered as the parser origin of the document + * @param parser instance of bzipParser that is registered as the parser origin of the document * @return a Document instance */ public static Document createMainDocument(final DigestURL location, final String mimeType, final String charset, final bzipParser parser) { diff --git a/source/net/yacy/document/parser/html/Scraper.java b/source/net/yacy/document/parser/html/Scraper.java index 704b3560b..cea71d743 100644 --- a/source/net/yacy/document/parser/html/Scraper.java +++ b/source/net/yacy/document/parser/html/Scraper.java @@ -50,7 +50,7 @@ public interface Scraper { /** * Process plain text - * @param plain text to process + * @param text text to process * @param insideTag the eventual direct parent tag. May be null. */ public void scrapeText(char[] text, ContentScraper.Tag insideTag); diff --git a/source/net/yacy/document/parser/tarParser.java b/source/net/yacy/document/parser/tarParser.java index d71d68001..f1b7059c2 100644 --- a/source/net/yacy/document/parser/tarParser.java +++ b/source/net/yacy/document/parser/tarParser.java @@ -256,7 +256,7 @@ public class tarParser extends AbstractParser implements Parser { * the media type of the resource * @param charset * the charset name if known - * @param an + * @param parser * instance of tarParser that is registered as the parser origin of * the document * @return a Document instance diff --git a/source/net/yacy/http/servlets/YaCyDefaultServlet.java b/source/net/yacy/http/servlets/YaCyDefaultServlet.java index 0c77d1094..4b41c730d 100644 --- a/source/net/yacy/http/servlets/YaCyDefaultServlet.java +++ b/source/net/yacy/http/servlets/YaCyDefaultServlet.java @@ -1143,7 +1143,7 @@ public class YaCyDefaultServlet extends HttpServlet { * Write input stream content to response and close input stream. * @param response servlet response. Must not be null. * @param targetExt response file format - * @param tmp + * @param inStream * @throws IOException when a read/write error occured. */ private void writeInputStream(HttpServletResponse response, String targetExt, InputStream inStream) diff --git a/source/net/yacy/kelondro/blob/BEncodedHeap.java b/source/net/yacy/kelondro/blob/BEncodedHeap.java index 4cafad6fd..46dcdf40d 100644 --- a/source/net/yacy/kelondro/blob/BEncodedHeap.java +++ b/source/net/yacy/kelondro/blob/BEncodedHeap.java @@ -238,7 +238,7 @@ public class BEncodedHeap implements MapStore { /** * check if a row with given key exists in the table * - * @param name + * @param pk * @return true if the row exists */ private boolean containsKey(final byte[] pk) { @@ -248,7 +248,7 @@ public class BEncodedHeap implements MapStore { /** * check if a row with given key exists in the table This method is here to implement the Map interface * - * @param name + * @param key * @return true if the row exists */ @Override @@ -271,7 +271,7 @@ public class BEncodedHeap implements MapStore { /** * get a map from the table * - * @param name + * @param pk * @return the map if one found or NULL if no entry exists or the entry is corrupt * @throws SpaceExceededException * @throws IOException @@ -287,7 +287,7 @@ public class BEncodedHeap implements MapStore { /** * get a map from the table this method is here to implement the Map interface * - * @param name + * @param key * @return the map if one found or NULL if no entry exists or the entry is corrupt */ @Override @@ -383,7 +383,7 @@ public class BEncodedHeap implements MapStore { * insert a map into the table this method shall be used in exchange of the get method if the previous * entry value is not needed. * - * @param name + * @param pk * @param map * @throws SpaceExceededException * @throws IOException @@ -431,7 +431,7 @@ public class BEncodedHeap implements MapStore { /** * insert a map into the table * - * @param name + * @param pk * @param map */ @Override @@ -454,7 +454,7 @@ public class BEncodedHeap implements MapStore { /** * delete a map from the table * - * @param name + * @param pk * @throws IOException */ public void delete(final byte[] pk) throws IOException { @@ -464,7 +464,7 @@ public class BEncodedHeap implements MapStore { /** * delete a map from the table * - * @param name + * @param key * @throws SpaceExceededException * @throws IOException */ @@ -493,7 +493,7 @@ public class BEncodedHeap implements MapStore { /** * Copy all the mappings from the specified map to this map. * - * @param m mappings to be stored in this map + * @param map mappings to be stored in this map */ @Override public void putAll(final Map> map) { diff --git a/source/net/yacy/kelondro/blob/Stack.java b/source/net/yacy/kelondro/blob/Stack.java index 45e8696a6..5442987ed 100644 --- a/source/net/yacy/kelondro/blob/Stack.java +++ b/source/net/yacy/kelondro/blob/Stack.java @@ -110,7 +110,7 @@ public class Stack { * push a new element on the top of the stack using a entry object * this is only useful for internal processes where a special handle * is created - * @param b the new stack element + * @param e the new stack element * @return the handle used to store the new element * @throws IOException * @throws SpaceExceededException diff --git a/source/net/yacy/kelondro/blob/Stacks.java b/source/net/yacy/kelondro/blob/Stacks.java index 543ac0d9d..e716a6b08 100644 --- a/source/net/yacy/kelondro/blob/Stacks.java +++ b/source/net/yacy/kelondro/blob/Stacks.java @@ -43,7 +43,8 @@ public class Stacks { * Stacks can be created on-the-fly in the given stacksLocation directory * using simple push operations that create first entries in the stack * Stacks that do not contain any element upon the close() operation are removed - * @param stackFile + * @param stacksLocation + * @param stacksPrefix * @throws IOException */ public Stacks(final File stacksLocation, final String stacksPrefix) { @@ -160,7 +161,7 @@ public class Stacks { * this is only useful for internal processes where a special handle * is created * @param stack the name of the stack - * @param b the new stack element + * @param e the new stack element * @return the handle used to store the new element * @throws IOException * @throws SpaceExceededException diff --git a/source/net/yacy/kelondro/blob/TablesColumnIndex.java b/source/net/yacy/kelondro/blob/TablesColumnIndex.java index 536e4e9f4..3dcdac4ae 100644 --- a/source/net/yacy/kelondro/blob/TablesColumnIndex.java +++ b/source/net/yacy/kelondro/blob/TablesColumnIndex.java @@ -68,7 +68,6 @@ public abstract class TablesColumnIndex { /** * create an index for a given table and given columns * @param columns - a map of column names and booleans for 'valueIsArray' you want to build an index for - * @param separator - a string value used to split column values into an array * @param table - an iterator over table rows which should be added to the index */ public synchronized void buildIndex(final Map columns, final Iterator table) { diff --git a/source/net/yacy/kelondro/data/word/WordReferenceVars.java b/source/net/yacy/kelondro/data/word/WordReferenceVars.java index c045b0ff4..6bff5171b 100644 --- a/source/net/yacy/kelondro/data/word/WordReferenceVars.java +++ b/source/net/yacy/kelondro/data/word/WordReferenceVars.java @@ -275,7 +275,7 @@ public class WordReferenceVars extends AbstractReference implements WordReferenc /** * Word positions for joined references (for multi word queries). - * @see posintext() + * @see #posintext() * @return the word positions of the joined references */ @Override diff --git a/source/net/yacy/kelondro/index/RowHandleMap.java b/source/net/yacy/kelondro/index/RowHandleMap.java index 9b845cbe2..0d7eaf413 100644 --- a/source/net/yacy/kelondro/index/RowHandleMap.java +++ b/source/net/yacy/kelondro/index/RowHandleMap.java @@ -69,7 +69,9 @@ public final class RowHandleMap implements HandleMap, Iterable, * import an exported collection * @param rowdef * @param exportedCollectionRowEnvironment - * @param columnInEnvironment */ public RowSet(final Row rowdef, final Row.Entry exportedCollectionRowEnvironment) { super(rowdef, exportedCollectionRowEnvironment); @@ -158,7 +157,7 @@ public class RowSet extends RowCollection implements Index, Iterable, /** * Adds the row to the index. The row is identified by the primary key of the row. - * @param row a index row + * @param entry a index row * @return true if this set did _not_ already contain the given row. * @throws IOException * @throws SpaceExceededException @@ -499,7 +498,8 @@ public class RowSet extends RowCollection implements Index, Iterable, /** * merge this row collection with another row collection using an simultanous iteration of the input collections * the current collection is not altered in any way, the returned collection is a new collection with copied content. - * @param c + * @param c0 + * @param c1 * @return * @throws SpaceExceededException */ diff --git a/source/net/yacy/peers/graphics/WebStructureGraph.java b/source/net/yacy/peers/graphics/WebStructureGraph.java index bb38bbd6c..e1b544a6f 100644 --- a/source/net/yacy/peers/graphics/WebStructureGraph.java +++ b/source/net/yacy/peers/graphics/WebStructureGraph.java @@ -352,7 +352,7 @@ public class WebStructureGraph { /** * Compute outgoing references from the source host hash - * @param srcHostName reference source host hash + * @param hosthash reference source host hash * @return outgoing structure with references mapped from target host hashes to counts or null when the host is not known */ public StructureEntry outgoingReferences(final String hosthash) { diff --git a/source/net/yacy/repository/BlacklistHelper.java b/source/net/yacy/repository/BlacklistHelper.java index fa5a15cef..27b822e11 100644 --- a/source/net/yacy/repository/BlacklistHelper.java +++ b/source/net/yacy/repository/BlacklistHelper.java @@ -59,7 +59,6 @@ public final class BlacklistHelper { * @param blacklistToUse the name of the blacklist the entry is to be added to * @param entry the entry that is to be added * @param header the current HTTP request headers - * @param supportedBlacklistTypes * @return true when no error occurred and the entry was successfully added */ public static boolean addBlacklistEntry( @@ -100,7 +99,6 @@ public final class BlacklistHelper { * @param blacklistToUse the name of the blacklist the entry is to be deleted from * @param entry the entry that is to be deleted * @param header - * @param supportedBlacklistTypes * @return null if no error occurred, else a String to put into LOCATION */ public static String deleteBlacklistEntry( diff --git a/source/net/yacy/search/schema/WebgraphConfiguration.java b/source/net/yacy/search/schema/WebgraphConfiguration.java index 2ac93d125..7ee09e4d5 100644 --- a/source/net/yacy/search/schema/WebgraphConfiguration.java +++ b/source/net/yacy/search/schema/WebgraphConfiguration.java @@ -285,7 +285,7 @@ public class WebgraphConfiguration extends SchemaConfiguration implements Serial * encode a string containing attributes from anchor rel properties binary: * bit 0: "me" contained in rel * bit 1: "nofollow" contained in rel - * @param rel + * @param rels * @return binary encoded information about rel */ private static int relEval(final String rels) { diff --git a/source/net/yacy/search/snippet/TextSnippet.java b/source/net/yacy/search/snippet/TextSnippet.java index 192015faa..328988cf0 100644 --- a/source/net/yacy/search/snippet/TextSnippet.java +++ b/source/net/yacy/search/snippet/TextSnippet.java @@ -390,7 +390,7 @@ public class TextSnippet implements Comparable, Comparator