Commit 205ec2cb authored by Piotr Gawron's avatar Piotr Gawron
Browse files

javadoc parameter names must match method signature

parent 682c249d
......@@ -102,8 +102,8 @@ public class ModelAnnotator {
/**
* Performs all possible and automatic annotations on the model.
*
* @param annotators
* this map contains lists of {@link ElementAnnotator} objects that
* @param annotationSchema
* information about {@link ElementAnnotator} objects that
* should be used for a given classes
* @param model
* model to update
......
......@@ -166,7 +166,7 @@ public class CazyAnnotator extends ElementAnnotator implements IExternalService
/**
* Transform UniProt identifier to CAZy identifier.
*
* @param UniProt
* @param uniprot
* {@link MiriamData} with UniProt identifier
* @return {@link MiriamData} with CAZy identifier
* @throws AnnotatorException
......
......@@ -134,7 +134,7 @@ public class ChebiAnnotator extends ElementAnnotator implements IExternalService
/**
* Returns {@link MiriamData} for given chebi name.
*
* @param name
* @param inputName
* name of the entry in chebi database.
* @return {@link MiriamData} entry for given chebi name
* @throws ChebiSearchException
......@@ -209,9 +209,9 @@ public class ChebiAnnotator extends ElementAnnotator implements IExternalService
* This method returns list of ChEBI identifiers that correspond to the whole
* chebi tree for a given chemical name.
*
* @param name
* - name of chemical
* @return - list of ChEBI identifiers
* @param inputName
* name of chemical
* @return list of ChEBI identifiers
* @throws ChebiSearchException
* thrown when there is a problem with accessing data from external
* chebi database
......
......@@ -107,7 +107,7 @@ public class StringAnnotator extends ElementAnnotator implements IExternalServic
/**
* Transform UniProt {@link MiriamData} data to STRING {@link MiriamData}.
*
* @param UniProt
* @param uniprot
* {@link MiriamData} with UniProt identifier
* @return {@link MiriamData} with STRING identifier
* @throws AnnotatorException
......
......@@ -266,14 +266,14 @@
<property name="target"
value="CLASS_DEF, INTERFACE_DEF, ENUM_DEF, METHOD_DEF, CTOR_DEF, VARIABLE_DEF"/>
</module>
<!-- <module name="JavadocMethod">
<module name="JavadocMethod">
<property name="scope" value="public"/>
<property name="allowMissingParamTags" value="true"/>
<property name="allowMissingReturnTag" value="true"/>
<property name="allowedAnnotations" value="Override, Test"/>
<property name="tokens" value="METHOD_DEF, CTOR_DEF, ANNOTATION_FIELD_DEF"/>
</module>
<module name="MethodName">
<!-- <module name="MethodName">
<property name="format" value="^[a-z][a-z0-9][a-zA-Z0-9_]*$"/>
<message key="name.invalidPattern"
value="Method name ''{0}'' must match pattern ''{1}''."/>
......
......@@ -69,7 +69,7 @@ public class ColorParser {
/**
* Extracts {@link Color} from input {@link String}.
*
* @param string
* @param inputString
* text to process
* @return {@link Color} obtained from input text
*/
......@@ -78,7 +78,7 @@ public class ColorParser {
throw new InvalidArgumentException(
"Invalid color value: " + inputString + ". Correct format: #xxxxxx (where x is a hex value)");
}
String string = inputString;
String string = inputString;
if (string.charAt(0) != '#') {
string = "#" + string;
}
......@@ -101,7 +101,7 @@ public class ColorParser {
/**
* Extracts {@link Color} from input {@link String}.
*
* @param string
* @param inputString
* text to process
* @return {@link Color} obtained from input text
*/
......@@ -110,7 +110,7 @@ public class ColorParser {
throw new InvalidArgumentException(
"Invalid color value: " + inputString + ". Correct format: #xxxxxxxx (where x is a hex value)");
}
String string = inputString;
String string = inputString;
if (string.charAt(0) != '#') {
string = "#" + string;
}
......
......@@ -162,8 +162,6 @@ public final class FontFinder {
* what are the borders
* @param text
* what text we want to write
* @param center
* should the text be centered
*/
public static void drawText(final int fontSize, final String fontName, final Graphics2D graphics, final Rectangle2D border, final String text,
final HorizontalAlign horizontalAlign, final VerticalAlign verticalAlign) {
......
......@@ -43,7 +43,7 @@ public final class MultiPackageNamingUtils {
* Returns id of the {@link MultiSpeciesType} for a given minerva element
* object.
*
* @param speciesClass
* @param element
* object for which we want to get id
*
* @return id of the {@link MultiSpeciesType} for a given minerva object
......
......@@ -737,9 +737,6 @@ public class ColorSchemaReader {
* @param schemaColumns
* map with {@link ColorSchemaColumn column types} to column number
* where result will be returned
* @param customIdentifiers
* identifiers columns (used when elements are identified by
* {@link MiriamType})
* @param type
* type of the color schema (for instance
* {@link DataOverlayType#GENETIC_VARIANT gene variants})
......
......@@ -29,8 +29,6 @@ public class GlyphZipEntryFile extends ZipEntryFile implements Serializable {
*
* @param filename
* {@link ZipEntryFile#filename}
* @param inputStream
* input stream with the data for this entry.
* @see #baos
* @throws IOException
* thrown when there is a problem with accessing input stream
......
......@@ -29,8 +29,6 @@ public class ImageZipEntryFile extends ZipEntryFile implements Serializable {
*
* @param filename
* {@link ZipEntryFile#filename}
* @param inputStream
* input stream with the data for this entry.
* @see #baos
* @throws IOException
* thrown when there is a problem with accessing input stream
......
......@@ -1584,7 +1584,7 @@ public enum MiriamType {
/**
* Creates {@link MiriamData} from miriam uri.
*
* @param miriamUri
* @param sourceMiriamUri
* miriam uri defining {@link MiriamData}
* @return {@link MiriamData} from miriam uri
*/
......
......@@ -204,7 +204,7 @@ public class Compartment extends Element {
* compartment. In case element2 lies inside complex the check with complex is
* made.
*
* @param element2
* @param element
* element to be checked
* @return true if the element2 cross this compartment, <code>false</code>
* otherwise
......
......@@ -5,7 +5,7 @@ public interface SpeciesWithModificationSite extends SpeciesWithModificationResi
/**
* Adds a {@link ModificationSite } to the species.
*
* @param codingRegion
* @param modificationSite
* {@link ModificationSite } to add
*/
void addModificationSite(final ModificationSite modificationSite);
......
......@@ -132,8 +132,8 @@ public class UniprotRecord implements Serializable {
}
/**
* @param uniprot
* id the id to set
* @param uniprotId
* the id to set
* @see #idModificationResidue
*/
public void setUniprotId(final String uniprotId) {
......
......@@ -81,7 +81,7 @@ public class AnnotatorConfigParameter extends AnnotatorParameter implements Seri
}
/**
* @param parameter
* @param paramValue
* value the {@link AnnotatorConfigParameter#value} to set
*/
public void setValue(final String paramValue) {
......
......@@ -110,11 +110,6 @@ public class AnnotatorData implements Serializable {
return annotatorClassName;
}
/**
* @param className
* the className to set
* @see #className
*/
public void setAnnotatorClassName(final Class<?> annotatorClassName) {
this.annotatorClassName = annotatorClassName;
}
......
......@@ -19,8 +19,8 @@ public interface ISearchService {
* Search for elements on the map by query. Returns many possibilities from best
* matching to less matching possibility.
*
* @param model
* model on which we perform search
* @param projectId
* projectId on which we perform search
* @param query
* the query
* @param limit
......@@ -40,8 +40,8 @@ public interface ISearchService {
/**
* Returns the closest elements to the coordinates on the model.
*
* @param model
* model on which the search is performed
* @param projectId
* projectId on which the search is performed
* @param point
* coordinates where search is performed
* @param numberOfElements
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment