diff --git a/api/src/main/java/edu/cornell/mannlib/vedit/util/FormUtils.java b/api/src/main/java/edu/cornell/mannlib/vedit/util/FormUtils.java index 3b50449ac..cf217bd8e 100644 --- a/api/src/main/java/edu/cornell/mannlib/vedit/util/FormUtils.java +++ b/api/src/main/java/edu/cornell/mannlib/vedit/util/FormUtils.java @@ -370,8 +370,7 @@ public class FormUtils { /** * Decodes a Base-64-encoded String of format * key:value;key2:value2;key3:value, and puts the keys and values in a Map - * @param params - * @return + * @param params Parameters */ public static Map beanParamMapFromString(String params) { String[] param = params.split(";"); diff --git a/api/src/main/java/edu/cornell/mannlib/vitro/webapp/auth/policy/specialrelationships/RelationshipChecker.java b/api/src/main/java/edu/cornell/mannlib/vitro/webapp/auth/policy/specialrelationships/RelationshipChecker.java index 3016aba5d..c696efe05 100644 --- a/api/src/main/java/edu/cornell/mannlib/vitro/webapp/auth/policy/specialrelationships/RelationshipChecker.java +++ b/api/src/main/java/edu/cornell/mannlib/vitro/webapp/auth/policy/specialrelationships/RelationshipChecker.java @@ -56,7 +56,7 @@ public class RelationshipChecker { /** * Is this resource a member of this type? That is, is there an statement of - * the form: rdfs:type + * the form: {@code rdfs:type } */ public boolean isResourceOfType(String resourceUri, String typeUri) { Selector selector = createSelector(resourceUri, @@ -86,7 +86,7 @@ public class RelationshipChecker { /** * Get a list of the object URIs that satisfy this statement: * - * + * {@code } * * May return an empty list, but never returns null. */ @@ -117,9 +117,9 @@ public class RelationshipChecker { /** * Get a list of the object URIs that satisfy these statements: * - * + * {@code } * - * + * {@code } * * May return an empty list, but never returns null. */ @@ -161,11 +161,11 @@ public class RelationshipChecker { * * So we're looking for object URIs that statisfy these statements: * - * + * {@code } * - * rdfs:type + * {@code rdfs:type } * - * + * {@code } */ public List getObjectsThroughLinkingNode(String resourceUri, String property1Uri, String linkNodeTypeUri, String property2Uri) { diff --git a/api/src/main/java/edu/cornell/mannlib/vitro/webapp/auth/requestedAction/ifaces/RequiresActions.java b/api/src/main/java/edu/cornell/mannlib/vitro/webapp/auth/requestedAction/ifaces/RequiresActions.java index df3e801da..0f4393e2f 100644 --- a/api/src/main/java/edu/cornell/mannlib/vitro/webapp/auth/requestedAction/ifaces/RequiresActions.java +++ b/api/src/main/java/edu/cornell/mannlib/vitro/webapp/auth/requestedAction/ifaces/RequiresActions.java @@ -27,7 +27,7 @@ public interface RequiresActions { * calling this method would then have the ability to * deny the action if it is not authorized. * - * @param vreq + * @param vreq Vitro request * @return Should not be null. Return Actions.AUTHORIZED * if no authorization is required to do use the object. */ diff --git a/api/src/main/java/edu/cornell/mannlib/vitro/webapp/beans/ApplicationBean.java b/api/src/main/java/edu/cornell/mannlib/vitro/webapp/beans/ApplicationBean.java index 99dec7616..76b74ed82 100644 --- a/api/src/main/java/edu/cornell/mannlib/vitro/webapp/beans/ApplicationBean.java +++ b/api/src/main/java/edu/cornell/mannlib/vitro/webapp/beans/ApplicationBean.java @@ -182,7 +182,6 @@ public class ApplicationBean { /** * Directory to find the images. Subdirectories include css, jsp and site_icons. * Example: "themes/enhanced/" - * @return */ public String getThemeDir(){ if (themeInfo.isValidThemeDir(themeDir)) { diff --git a/api/src/main/java/edu/cornell/mannlib/vitro/webapp/beans/DataProperty.java b/api/src/main/java/edu/cornell/mannlib/vitro/webapp/beans/DataProperty.java index 191485226..fef38df6d 100644 --- a/api/src/main/java/edu/cornell/mannlib/vitro/webapp/beans/DataProperty.java +++ b/api/src/main/java/edu/cornell/mannlib/vitro/webapp/beans/DataProperty.java @@ -155,7 +155,7 @@ public class DataProperty extends Property implements Comparable, /** * adds a single DataPropertyStatement object to a DatatypeProperty's DataPropertyStatements list. - * @param dataPropertyStmt + * @param dataPropertyStmt Data property statement */ public void addDataPropertyStatement(DataPropertyStatement dataPropertyStmt){ diff --git a/api/src/main/java/edu/cornell/mannlib/vitro/webapp/beans/FauxProperty.java b/api/src/main/java/edu/cornell/mannlib/vitro/webapp/beans/FauxProperty.java index 2d868520a..a48d9265d 100644 --- a/api/src/main/java/edu/cornell/mannlib/vitro/webapp/beans/FauxProperty.java +++ b/api/src/main/java/edu/cornell/mannlib/vitro/webapp/beans/FauxProperty.java @@ -43,14 +43,14 @@ public class FauxProperty extends BaseResourceBean implements ResourceBean, private String customListView; /** - * Arguments are in this order to mimic the relationship: subject ==> - * property ==> object + * Arguments are in this order to mimic the relationship: subject ==> + * property ==> object * * @param domainURI * URI of the subject class. May be null. * @param baseURI * URI of the property. May not be null. - * @param rangeUri + * @param rangeURI * URI of the object class. May be null. */ public FauxProperty(String domainURI, String baseURI, String rangeURI) { diff --git a/api/src/main/java/edu/cornell/mannlib/vitro/webapp/beans/Individual.java b/api/src/main/java/edu/cornell/mannlib/vitro/webapp/beans/Individual.java index 84fc3d935..43d2a5b78 100644 --- a/api/src/main/java/edu/cornell/mannlib/vitro/webapp/beans/Individual.java +++ b/api/src/main/java/edu/cornell/mannlib/vitro/webapp/beans/Individual.java @@ -109,7 +109,7 @@ public interface Individual extends ResourceBean, Comparable { * This is crap. It was put in so IndividualFiltering could filter object properties properly, * but what we really need is either: filters have a reference to a webappDaoFactory, or * all ObjectPropertyStatements are resolved when they are created. See VIVO-946 and VIVO-984. - * @param list + * @param list Object property statements */ void resolveAsFauxPropertyStatements(List list); } diff --git a/api/src/main/java/edu/cornell/mannlib/vitro/webapp/beans/IndividualImpl.java b/api/src/main/java/edu/cornell/mannlib/vitro/webapp/beans/IndividualImpl.java index 94b3262e6..e8023c8d1 100755 --- a/api/src/main/java/edu/cornell/mannlib/vitro/webapp/beans/IndividualImpl.java +++ b/api/src/main/java/edu/cornell/mannlib/vitro/webapp/beans/IndividualImpl.java @@ -23,7 +23,7 @@ import edu.cornell.mannlib.vitro.webapp.filestorage.model.ImageInfo; public class IndividualImpl extends BaseResourceBean implements Individual, Comparable { /** * This can be used as a "not initialized" indicator for a property that - * could validly be set to null. If get() is + * could validly be set to {@code null}. If {@code get()} is * called on such a property, and the property has this value, the correct * value can be fetched and cached. */ diff --git a/api/src/main/java/edu/cornell/mannlib/vitro/webapp/beans/ObjectProperty.java b/api/src/main/java/edu/cornell/mannlib/vitro/webapp/beans/ObjectProperty.java index 37405653e..c3568bc6c 100644 --- a/api/src/main/java/edu/cornell/mannlib/vitro/webapp/beans/ObjectProperty.java +++ b/api/src/main/java/edu/cornell/mannlib/vitro/webapp/beans/ObjectProperty.java @@ -253,7 +253,6 @@ public class ObjectProperty extends Property implements Comparable implements Comparable getCompare(){ return new Comparator(){ diff --git a/api/src/main/java/edu/cornell/mannlib/vitro/webapp/config/ConfigurationProperties.java b/api/src/main/java/edu/cornell/mannlib/vitro/webapp/config/ConfigurationProperties.java index 2b861cc1b..efc889249 100644 --- a/api/src/main/java/edu/cornell/mannlib/vitro/webapp/config/ConfigurationProperties.java +++ b/api/src/main/java/edu/cornell/mannlib/vitro/webapp/config/ConfigurationProperties.java @@ -125,7 +125,7 @@ public abstract class ConfigurationProperties { // ---------------------------------------------------------------------- /** - * Get the value of the property, or null if the property has + * Get the value of the property, or {@code null} if the property has * not been assigned a value. */ public abstract String getProperty(String key); diff --git a/api/src/main/java/edu/cornell/mannlib/vitro/webapp/controller/DashboardPropertyListController.java b/api/src/main/java/edu/cornell/mannlib/vitro/webapp/controller/DashboardPropertyListController.java index fe03f377f..3fec39a99 100644 --- a/api/src/main/java/edu/cornell/mannlib/vitro/webapp/controller/DashboardPropertyListController.java +++ b/api/src/main/java/edu/cornell/mannlib/vitro/webapp/controller/DashboardPropertyListController.java @@ -48,8 +48,6 @@ public class DashboardPropertyListController extends VitroHttpServlet { * * Expected Attributes: * entity - set to entity to display properties for. - * - * @author bdc34, then jc55 */ private static final Log log = LogFactory.getLog(DashboardPropertyListController.class.getName()); diff --git a/api/src/main/java/edu/cornell/mannlib/vitro/webapp/controller/MailUsersServlet.java b/api/src/main/java/edu/cornell/mannlib/vitro/webapp/controller/MailUsersServlet.java index 6cf698e6a..25d05b123 100644 --- a/api/src/main/java/edu/cornell/mannlib/vitro/webapp/controller/MailUsersServlet.java +++ b/api/src/main/java/edu/cornell/mannlib/vitro/webapp/controller/MailUsersServlet.java @@ -226,7 +226,7 @@ public class MailUsersServlet extends VitroHttpServlet { } /** Intended to mangle url so it can get through spam filtering - * http://host/dir/servlet?param=value -> host: dir/servlet?param=value */ + * http://host/dir/servlet?param=value -> host: dir/servlet?param=value */ public String stripProtocol( String in ){ if( in == null ) return ""; diff --git a/api/src/main/java/edu/cornell/mannlib/vitro/webapp/controller/MultipartRequestWrapper.java b/api/src/main/java/edu/cornell/mannlib/vitro/webapp/controller/MultipartRequestWrapper.java index 861d400f8..f3d52258c 100644 --- a/api/src/main/java/edu/cornell/mannlib/vitro/webapp/controller/MultipartRequestWrapper.java +++ b/api/src/main/java/edu/cornell/mannlib/vitro/webapp/controller/MultipartRequestWrapper.java @@ -37,8 +37,8 @@ import org.apache.commons.logging.LogFactory; * * The List of FileItems includes both "formField" items and "file" items. As * with the usual parameters on a request, we can have more than one value with - * the same name. So this creates a map of > to hold the - * parameters, and a map of > to hold the files. + * the same name. So this creates a map of <String, List<String>> to hold the + * parameters, and a map of <String, List<FileItem>> to hold the files. * * The parameters will be available to the wrapper through the normal methods. * The files will be available as an attribute that holds the map. Also, a diff --git a/api/src/main/java/edu/cornell/mannlib/vitro/webapp/controller/freemarker/ContactMailController.java b/api/src/main/java/edu/cornell/mannlib/vitro/webapp/controller/freemarker/ContactMailController.java index f76d5e9c8..297042279 100644 --- a/api/src/main/java/edu/cornell/mannlib/vitro/webapp/controller/freemarker/ContactMailController.java +++ b/api/src/main/java/edu/cornell/mannlib/vitro/webapp/controller/freemarker/ContactMailController.java @@ -197,7 +197,7 @@ public class ContactMailController extends FreemarkerHttpServlet { } /** Intended to mangle url so it can get through spam filtering - * http://host/dir/servlet?param=value -> host: dir/servlet?param=value */ + * http://host/dir/servlet?param=value -> host: dir/servlet?param=value */ public String stripProtocol( String in ){ if( in == null ) return ""; diff --git a/api/src/main/java/edu/cornell/mannlib/vitro/webapp/controller/freemarker/FreemarkerHttpServlet.java b/api/src/main/java/edu/cornell/mannlib/vitro/webapp/controller/freemarker/FreemarkerHttpServlet.java index dd23a38e3..491aec56c 100644 --- a/api/src/main/java/edu/cornell/mannlib/vitro/webapp/controller/freemarker/FreemarkerHttpServlet.java +++ b/api/src/main/java/edu/cornell/mannlib/vitro/webapp/controller/freemarker/FreemarkerHttpServlet.java @@ -429,8 +429,6 @@ public class FreemarkerHttpServlet extends VitroHttpServlet { * shared variables in the Configuration. (Though we could reset them like other * shared variables. These variables are not needed outside the page and body templates, * however. If they are needed elsewhere, add to shared variables. - * @param VitroRequest vreq - * @return Map */ // RY This is protected instead of private so FreeMarkerComponentGenerator can access. // Once we don't need that (i.e., jsps have been eliminated) it can be made private. diff --git a/api/src/main/java/edu/cornell/mannlib/vitro/webapp/controller/freemarker/ImageUploadHelper.java b/api/src/main/java/edu/cornell/mannlib/vitro/webapp/controller/freemarker/ImageUploadHelper.java index 91bcd0a15..e7bb9eb45 100644 --- a/api/src/main/java/edu/cornell/mannlib/vitro/webapp/controller/freemarker/ImageUploadHelper.java +++ b/api/src/main/java/edu/cornell/mannlib/vitro/webapp/controller/freemarker/ImageUploadHelper.java @@ -106,7 +106,7 @@ public class ImageUploadHelper { * The image must be present and non-empty, and must have a mime-type that * represents an image we support. * - * We rely on the fact that a {@link FileUploadServletRequest} will always + * We rely on the fact that a FileUploadServletRequest will always * have a map of {@link FileItem}s, even if it is empty. However, that map * may not contain the field that we want, or that field may contain an * empty file. diff --git a/api/src/main/java/edu/cornell/mannlib/vitro/webapp/controller/grefine/GrefineMqlreadServlet.java b/api/src/main/java/edu/cornell/mannlib/vitro/webapp/controller/grefine/GrefineMqlreadServlet.java index 810a44869..03b4dcc31 100644 --- a/api/src/main/java/edu/cornell/mannlib/vitro/webapp/controller/grefine/GrefineMqlreadServlet.java +++ b/api/src/main/java/edu/cornell/mannlib/vitro/webapp/controller/grefine/GrefineMqlreadServlet.java @@ -125,9 +125,9 @@ public class GrefineMqlreadServlet extends VitroHttpServlet { /** * Construct json from query String - * @param query - * @param subjectUriList - * @param propertyUriMap + * @param query Query + * @param subjectUriList Subject URIs + * @param propertyUriMap Property maps */ private void parseQuery(String query, ArrayList subjectUriList, Map propertyUriMap) { try { diff --git a/api/src/main/java/edu/cornell/mannlib/vitro/webapp/controller/grefine/JSONReconcileServlet.java b/api/src/main/java/edu/cornell/mannlib/vitro/webapp/controller/grefine/JSONReconcileServlet.java index 01ed16d9a..29b005548 100644 --- a/api/src/main/java/edu/cornell/mannlib/vitro/webapp/controller/grefine/JSONReconcileServlet.java +++ b/api/src/main/java/edu/cornell/mannlib/vitro/webapp/controller/grefine/JSONReconcileServlet.java @@ -172,9 +172,8 @@ public class JSONReconcileServlet extends VitroHttpServlet { /** * Returns a default JSON response. * - * @param req - * @param resp - * @return + * @param req Servlet Request + * @param resp Servlet Response * @throws ServletException */ protected JSONObject getMetadata(HttpServletRequest req, HttpServletResponse resp, String defaultNamespace, diff --git a/api/src/main/java/edu/cornell/mannlib/vitro/webapp/controller/individual/ExtendedRdfAssembler.java b/api/src/main/java/edu/cornell/mannlib/vitro/webapp/controller/individual/ExtendedRdfAssembler.java index 852afcfcf..96326945f 100644 --- a/api/src/main/java/edu/cornell/mannlib/vitro/webapp/controller/individual/ExtendedRdfAssembler.java +++ b/api/src/main/java/edu/cornell/mannlib/vitro/webapp/controller/individual/ExtendedRdfAssembler.java @@ -78,7 +78,6 @@ public class ExtendedRdfAssembler { } /** - * @return */ public ResponseValues assembleRdf() { OntModel ontModel = vreq.getJenaOntModel(); diff --git a/api/src/main/java/edu/cornell/mannlib/vitro/webapp/controller/jena/JenaXMLFileUpload.java b/api/src/main/java/edu/cornell/mannlib/vitro/webapp/controller/jena/JenaXMLFileUpload.java index a0a7673f9..c3ca7af2c 100644 --- a/api/src/main/java/edu/cornell/mannlib/vitro/webapp/controller/jena/JenaXMLFileUpload.java +++ b/api/src/main/java/edu/cornell/mannlib/vitro/webapp/controller/jena/JenaXMLFileUpload.java @@ -229,8 +229,7 @@ public class JenaXMLFileUpload extends JenaIngestController { /** * Save files to baseDirectoryForFiles and return a list of File objects. - * @param fileStreams - * @return + * @param fileStreams File streams to process * @throws ServletException */ private List saveFiles( Map> fileStreams ) throws ServletException{ diff --git a/api/src/main/java/edu/cornell/mannlib/vitro/webapp/controller/json/GetEntitiesByVClass.java b/api/src/main/java/edu/cornell/mannlib/vitro/webapp/controller/json/GetEntitiesByVClass.java index 467f6f69c..63716d973 100644 --- a/api/src/main/java/edu/cornell/mannlib/vitro/webapp/controller/json/GetEntitiesByVClass.java +++ b/api/src/main/java/edu/cornell/mannlib/vitro/webapp/controller/json/GetEntitiesByVClass.java @@ -33,13 +33,14 @@ import edu.cornell.mannlib.vitro.webapp.dao.WebappDaoFactory; * If there are more entities the last item on the returned array will be an object * with no id property. It will look like this: * + * {@code * {"resultGroup":0, * "resultKey":"2WEK2306", * "nextUrl":"http://caruso.mannlib.cornell.edu:8080/vitro/dataservice?getEntitiesByVClass=1&resultKey=2WEK2306&resultGroup=1&vclassId=null", * "entsInVClass":1752, * "nextResultGroup":1, * "standardReplySize":256} - * + * } */ public class GetEntitiesByVClass extends JsonArrayProducer { private static final Log log = LogFactory.getLog(GetEntitiesByVClass.class); diff --git a/api/src/main/java/edu/cornell/mannlib/vitro/webapp/dao/IndividualDao.java b/api/src/main/java/edu/cornell/mannlib/vitro/webapp/dao/IndividualDao.java index a2769f971..9fadbded5 100644 --- a/api/src/main/java/edu/cornell/mannlib/vitro/webapp/dao/IndividualDao.java +++ b/api/src/main/java/edu/cornell/mannlib/vitro/webapp/dao/IndividualDao.java @@ -22,22 +22,21 @@ public interface IndividualDao { /** * Adds the specified Individual to the specified VClass (i.e. adds rdf:type). - * @param individualURI - * @param vclassURI + * @param individualURI Individual URI + * @param vclassURI URI for VClass */ public abstract void addVClass(String individualURI, String vclassURI); /** * Removes the specified Individual from the specificed VClass (i.e. retracts rdf:type) - * @param individualURI - * @param vclassURI + * @param individualURI Individual URI + * @param vclassURI URI for VCLass */ public abstract void removeVClass(String individualURI, String vclassURI); /** * Returns a list of all the Individuals in the specified VClass. - * @param vclass - * @return + * @param vclass VClass */ public abstract List getIndividualsByVClass(VClass vclass); @@ -53,7 +52,7 @@ public interface IndividualDao { int quantity); /** - * @returns new individual URI if success. + * @return new individual URI if success. */ public abstract String insertNewIndividual(Individual individual) throws InsertException; @@ -65,7 +64,7 @@ public interface IndividualDao { /** * deletes a single individual from the knowledge base. - * @param id + * @param individualURI URI of an individual * @return 0 on failed */ public abstract int deleteIndividual(String individualURI); @@ -78,7 +77,7 @@ public interface IndividualDao { * Get a row from the entities table and make an Entity. * PropertiesList will not be filled out. * VClass will be filled out. - * @param entityId + * @param individualURI URI for Individual * @return an Entity object or null if not found. */ public abstract Individual getIndividualByURI(String individualURI); diff --git a/api/src/main/java/edu/cornell/mannlib/vitro/webapp/dao/ObjectPropertyDao.java b/api/src/main/java/edu/cornell/mannlib/vitro/webapp/dao/ObjectPropertyDao.java index 82df46d3a..b612acc1b 100755 --- a/api/src/main/java/edu/cornell/mannlib/vitro/webapp/dao/ObjectPropertyDao.java +++ b/api/src/main/java/edu/cornell/mannlib/vitro/webapp/dao/ObjectPropertyDao.java @@ -19,10 +19,10 @@ public interface ObjectPropertyDao extends PropertyDao { * Use this method to supply a base ObjectProperty whose fields will be updated * as necessary to correspond to the configuration for the specified Domain * and Range. - * @param objectPropertyURI - * @param domainURI - * @param rangeURI - * @param base + * @param objectPropertyURI Object Property URI + * @param domainURI Domain URI + * @param rangeURI Range URI + * @param base Object property * @return ObjectProperty */ public ObjectProperty getObjectPropertyByURIs(String objectPropertyURI, String domainURI, String rangeURI, ObjectProperty base); diff --git a/api/src/main/java/edu/cornell/mannlib/vitro/webapp/dao/PageDao.java b/api/src/main/java/edu/cornell/mannlib/vitro/webapp/dao/PageDao.java index 3004dddd7..e8fc93329 100644 --- a/api/src/main/java/edu/cornell/mannlib/vitro/webapp/dao/PageDao.java +++ b/api/src/main/java/edu/cornell/mannlib/vitro/webapp/dao/PageDao.java @@ -10,14 +10,11 @@ public interface PageDao { /** * Returns a list of urlMappings to URIs. - * - * @return */ Map getPageMappings(); /** * Returns URI of home page. - * @return */ String getHomePageUri(); diff --git a/api/src/main/java/edu/cornell/mannlib/vitro/webapp/dao/VClassDao.java b/api/src/main/java/edu/cornell/mannlib/vitro/webapp/dao/VClassDao.java index 0c4ecce8a..3383fbb50 100755 --- a/api/src/main/java/edu/cornell/mannlib/vitro/webapp/dao/VClassDao.java +++ b/api/src/main/java/edu/cornell/mannlib/vitro/webapp/dao/VClassDao.java @@ -89,15 +89,15 @@ public interface VClassDao { void addVClassesToGroups(List groups ); /** - * @param vc1 - * @param vc2 + * @param vc1 VCLass + * @param vc2 VClass * @return true if vc1 subClassOf vc2 */ boolean isSubClassOf(VClass vc1, VClass vc2); /** - * @param vc1 - * @param vc2 + * @param vclassURI1 VClass URI + * @param vclassURI2 VClass URI * @return true if vc1 subClassOf vc2 */ boolean isSubClassOf(String vclassURI1, String vclassURI2); diff --git a/api/src/main/java/edu/cornell/mannlib/vitro/webapp/dao/VClassGroupDao.java b/api/src/main/java/edu/cornell/mannlib/vitro/webapp/dao/VClassGroupDao.java index 8c906c3b3..65a960d74 100644 --- a/api/src/main/java/edu/cornell/mannlib/vitro/webapp/dao/VClassGroupDao.java +++ b/api/src/main/java/edu/cornell/mannlib/vitro/webapp/dao/VClassGroupDao.java @@ -13,9 +13,7 @@ public interface VClassGroupDao { /** * Gets all of the ClassGroups as a map ordered by displayRank. - * VClassGroup.getPublicName() -> VClassGroup - * - * @return + * VClassGroup.getPublicName() -> VClassGroup */ public abstract LinkedHashMap getClassGroupMap(); @@ -27,24 +25,24 @@ public interface VClassGroupDao { /** * Return a list of VClassGroups with their associated VClasses - * @param displayOrder + * @param displayOrder Display order * @return List */ public abstract List getPublicGroupsWithVClasses(boolean displayOrder); /** * Return a list of VClassGroups with their associated VClasses - * @param displayOrder - * @param includeUninstantiatedClasses + * @param displayOrder Display order + * @param includeUninstantiatedClasses Include all classes * @return List */ public abstract List getPublicGroupsWithVClasses(boolean displayOrder, boolean includeUninstantiatedClasses); /** * Return a list of VClassGroups with their associated VClasses - * @param displayOrder - * @param includeUninstantiatedClasses - * @param getIndividualCount + * @param displayOrder Display order + * @param includeUninstantiatedClasses Include all classes + * @param getIndividualCount Retrieve individual count * @return List */ public abstract List getPublicGroupsWithVClasses(boolean displayOrder, boolean includeUninstantiatedClasses, boolean getIndividualCount); diff --git a/api/src/main/java/edu/cornell/mannlib/vitro/webapp/dao/WebappDaoFactory.java b/api/src/main/java/edu/cornell/mannlib/vitro/webapp/dao/WebappDaoFactory.java index fa76dc1ad..84f965cf5 100644 --- a/api/src/main/java/edu/cornell/mannlib/vitro/webapp/dao/WebappDaoFactory.java +++ b/api/src/main/java/edu/cornell/mannlib/vitro/webapp/dao/WebappDaoFactory.java @@ -32,8 +32,7 @@ public interface WebappDaoFactory { /** * Check if a given URI string exists in the system: * checks for the following conditions: URI found as subject in a statement or an object or as a property - * @param uriStr - * @return + * @param uriStr URI String */ public boolean hasExistingURI(String uriStr); @@ -54,15 +53,13 @@ public interface WebappDaoFactory { /** * Copy this DAO factory to a new object associated with the specified user * URI, or return the same factory if a user-aware version cannot be used. - * @param userURI - * @return + * @param userURI User URI */ public WebappDaoFactory getUserAwareDaoFactory(String userURI); /** * Return URI of user associated with this WebappDaoFactory, * or null if not applicable. - * @return */ public String getUserURI(); diff --git a/api/src/main/java/edu/cornell/mannlib/vitro/webapp/dao/jena/IndividualDaoSDB.java b/api/src/main/java/edu/cornell/mannlib/vitro/webapp/dao/jena/IndividualDaoSDB.java index 0ea68b060..b4512c3a4 100644 --- a/api/src/main/java/edu/cornell/mannlib/vitro/webapp/dao/jena/IndividualDaoSDB.java +++ b/api/src/main/java/edu/cornell/mannlib/vitro/webapp/dao/jena/IndividualDaoSDB.java @@ -308,7 +308,7 @@ public class IndividualDaoSDB extends IndividualDaoJena { /** * fills in the Individual objects needed for any ObjectPropertyStatements * attached to the specified individual. - * @param entity + * @param entity An individual */ private void fillIndividualsForObjectPropertyStatements(Individual entity){ getOntModel().enterCriticalSection(Lock.READ); diff --git a/api/src/main/java/edu/cornell/mannlib/vitro/webapp/dao/jena/JenaBaseDao.java b/api/src/main/java/edu/cornell/mannlib/vitro/webapp/dao/jena/JenaBaseDao.java index 74de28a8b..a9e9b2f92 100644 --- a/api/src/main/java/edu/cornell/mannlib/vitro/webapp/dao/jena/JenaBaseDao.java +++ b/api/src/main/java/edu/cornell/mannlib/vitro/webapp/dao/jena/JenaBaseDao.java @@ -461,9 +461,10 @@ public class JenaBaseDao extends JenaBaseDaoCon { /** * convenience method - * @param ind - * @param dataprop - * @param value + * @param res Resource + * @param dataprop Datatype property + * @param value Date + * @param model Jena Model */ protected synchronized void addPropertyDateValue(Resource res, DatatypeProperty dataprop, Date value, Model model) { if (dataprop != null && value != null) { @@ -916,7 +917,7 @@ public class JenaBaseDao extends JenaBaseDaoCon { /** * Checks a URI for validity. Jena models can store invalid URIs, but this causes RDF/XML output serialization to fail. - * @param uri + * @param uri URI * @return null if URI is good, otherwise an error message String */ protected String checkURI( String uri ) { @@ -1047,8 +1048,8 @@ public class JenaBaseDao extends JenaBaseDaoCon { /** * Returns additions and retractions to perform - * @param ontRes - * @param ontModel + * @param ontRes Ontology resource + * @param ontModel Ontology model * @return Model[] where [0] is retractions and [1] is additions */ protected Model[] getSmartRemoval(OntResource ontRes, OntModel ontModel) { diff --git a/api/src/main/java/edu/cornell/mannlib/vitro/webapp/dao/jena/JenaModelUtils.java b/api/src/main/java/edu/cornell/mannlib/vitro/webapp/dao/jena/JenaModelUtils.java index 93c9bd19d..fa370031e 100644 --- a/api/src/main/java/edu/cornell/mannlib/vitro/webapp/dao/jena/JenaModelUtils.java +++ b/api/src/main/java/edu/cornell/mannlib/vitro/webapp/dao/jena/JenaModelUtils.java @@ -60,7 +60,7 @@ public class JenaModelUtils { * an ontology. Also creates annotations to place each root class and all * of its children in the appropriate groups. In the case of multiple * inheritance, classgroup assignment will be arbitrary. - * @param wadf + * @param wadf DAO Factory * @param tboxModel containing ontology classes * @return resultArray of OntModels, where resultArray[0] is the model containing * the triples about the classgroups, and resultArray[1] is the model containing diff --git a/api/src/main/java/edu/cornell/mannlib/vitro/webapp/dao/jena/PageDaoJena.java b/api/src/main/java/edu/cornell/mannlib/vitro/webapp/dao/jena/PageDaoJena.java index fd333560b..612266e0f 100644 --- a/api/src/main/java/edu/cornell/mannlib/vitro/webapp/dao/jena/PageDaoJena.java +++ b/api/src/main/java/edu/cornell/mannlib/vitro/webapp/dao/jena/PageDaoJena.java @@ -370,8 +370,7 @@ public class PageDaoJena extends JenaBaseDao implements PageDao { * Gets a URI for display:forClassGroup for the specified page. * Only one value is expected in the model. * This may return null if there is no ClassGroup associated with the page. - * @param pageUri - * @return + * @param pageUri Page URI */ @Override public String getClassGroupPage(String pageUri) { diff --git a/api/src/main/java/edu/cornell/mannlib/vitro/webapp/dao/jena/PropertyDaoJena.java b/api/src/main/java/edu/cornell/mannlib/vitro/webapp/dao/jena/PropertyDaoJena.java index ec2062718..56676c2d7 100644 --- a/api/src/main/java/edu/cornell/mannlib/vitro/webapp/dao/jena/PropertyDaoJena.java +++ b/api/src/main/java/edu/cornell/mannlib/vitro/webapp/dao/jena/PropertyDaoJena.java @@ -412,7 +412,7 @@ public class PropertyDaoJena extends JenaBaseDao implements PropertyDao { /** * Find named classes to which a restriction "applies" - * @param resourceURI identifier of a class + * @param ontClass Ontology class * @return set of class URIs * * Note: this method assumes that the caller holds a read lock on @@ -461,7 +461,7 @@ public class PropertyDaoJena extends JenaBaseDao implements PropertyDao { /** * requires SPARQL 1.1 (or ARQ) property path support - * @param vclassURI + * @param vclassURI VClass URI * @return list of property resources with union domains that include the vclass */ protected List getPropertiesWithAppropriateDomainFor(String vclassURI) { diff --git a/api/src/main/java/edu/cornell/mannlib/vitro/webapp/dao/jena/RDFServiceGraph.java b/api/src/main/java/edu/cornell/mannlib/vitro/webapp/dao/jena/RDFServiceGraph.java index a8ad33786..4bea5bb45 100644 --- a/api/src/main/java/edu/cornell/mannlib/vitro/webapp/dao/jena/RDFServiceGraph.java +++ b/api/src/main/java/edu/cornell/mannlib/vitro/webapp/dao/jena/RDFServiceGraph.java @@ -60,7 +60,7 @@ public class RDFServiceGraph implements GraphWithPerform { /** * Returns a SparqlGraph for the union of named graphs in a remote repository - * @param endpointURI + * @param rdfService RDF Service */ public RDFServiceGraph(RDFService rdfService) { this(rdfService, null); @@ -68,8 +68,8 @@ public class RDFServiceGraph implements GraphWithPerform { /** * Returns a SparqlGraph for a particular named graph in a remote repository - * @param endpointURI - * @param graphURI + * @param rdfService RDFService + * @param graphURI Graph URI */ public RDFServiceGraph(RDFService rdfService, String graphURI) { this.rdfService = rdfService; diff --git a/api/src/main/java/edu/cornell/mannlib/vitro/webapp/dao/jena/RDFServiceGraphBulkUpdater.java b/api/src/main/java/edu/cornell/mannlib/vitro/webapp/dao/jena/RDFServiceGraphBulkUpdater.java index 3530fba32..acb56c612 100644 --- a/api/src/main/java/edu/cornell/mannlib/vitro/webapp/dao/jena/RDFServiceGraphBulkUpdater.java +++ b/api/src/main/java/edu/cornell/mannlib/vitro/webapp/dao/jena/RDFServiceGraphBulkUpdater.java @@ -89,8 +89,7 @@ public class RDFServiceGraphBulkUpdater implements BulkUpdateHandler { /** * Returns a pair of models. The first contains any statement containing at * least one blank node. The second contains all remaining statements. - * @param g - * @return + * @param g Graph */ private Model[] separateStatementsWithBlankNodes(Graph g) { diff --git a/api/src/main/java/edu/cornell/mannlib/vitro/webapp/dao/jena/SparqlGraph.java b/api/src/main/java/edu/cornell/mannlib/vitro/webapp/dao/jena/SparqlGraph.java index ff80fc81c..a03e461dd 100644 --- a/api/src/main/java/edu/cornell/mannlib/vitro/webapp/dao/jena/SparqlGraph.java +++ b/api/src/main/java/edu/cornell/mannlib/vitro/webapp/dao/jena/SparqlGraph.java @@ -60,7 +60,7 @@ public class SparqlGraph implements GraphWithPerform { /** * Returns a SparqlGraph for the union of named graphs in a remote repository - * @param endpointURI + * @param endpointURI Endpoint URI */ public SparqlGraph(String endpointURI) { this(endpointURI, null); @@ -68,8 +68,8 @@ public class SparqlGraph implements GraphWithPerform { /** * Returns a SparqlGraph for a particular named graph in a remote repository - * @param endpointURI - * @param graphURI + * @param endpointURI Endpoint URI + * @param graphURI Graph URI */ public SparqlGraph(String endpointURI, String graphURI) { this.endpointURI = endpointURI; diff --git a/api/src/main/java/edu/cornell/mannlib/vitro/webapp/dao/jena/SparqlGraphBulkUpdater.java b/api/src/main/java/edu/cornell/mannlib/vitro/webapp/dao/jena/SparqlGraphBulkUpdater.java index 25ed061c7..3a481096d 100644 --- a/api/src/main/java/edu/cornell/mannlib/vitro/webapp/dao/jena/SparqlGraphBulkUpdater.java +++ b/api/src/main/java/edu/cornell/mannlib/vitro/webapp/dao/jena/SparqlGraphBulkUpdater.java @@ -82,8 +82,7 @@ public class SparqlGraphBulkUpdater extends SimpleBulkUpdateHandler { /** * Returns a pair of models. The first contains any statement containing at * least one blank node. The second contains all remaining statements. - * @param g - * @return + * @param g Jena Graph */ private Model[] separateStatementsWithBlankNodes(Graph g) { diff --git a/api/src/main/java/edu/cornell/mannlib/vitro/webapp/dao/jena/VClassDaoJena.java b/api/src/main/java/edu/cornell/mannlib/vitro/webapp/dao/jena/VClassDaoJena.java index d136a95f7..1ebf320d3 100644 --- a/api/src/main/java/edu/cornell/mannlib/vitro/webapp/dao/jena/VClassDaoJena.java +++ b/api/src/main/java/edu/cornell/mannlib/vitro/webapp/dao/jena/VClassDaoJena.java @@ -493,7 +493,6 @@ public class VClassDaoJena extends JenaBaseDao implements VClassDao { * of determining whether something is a root class. * We also avoid ClassCastExceptions deep in Jena-land by eschewing Jena's * listSuperClasses() method. - * @author bjl23 */ private Iterator smarterListHierarchyRootClasses(OntModel ontModel, String ontologyURI) { List rootClassList = new ArrayList(); diff --git a/api/src/main/java/edu/cornell/mannlib/vitro/webapp/dao/jena/WebappDaoFactoryJena.java b/api/src/main/java/edu/cornell/mannlib/vitro/webapp/dao/jena/WebappDaoFactoryJena.java index 826c5f36a..0b83478d1 100644 --- a/api/src/main/java/edu/cornell/mannlib/vitro/webapp/dao/jena/WebappDaoFactoryJena.java +++ b/api/src/main/java/edu/cornell/mannlib/vitro/webapp/dao/jena/WebappDaoFactoryJena.java @@ -451,7 +451,7 @@ public class WebappDaoFactoryJena implements WebappDaoFactory { /** * Method for creating a copy - does not pass the same object - * @param base + * @param base DAO Factory */ public WebappDaoFactoryJena (WebappDaoFactoryJena base) { // Not sure if selector somehow has greater longevity so diff --git a/api/src/main/java/edu/cornell/mannlib/vitro/webapp/dwr/EntityDWR.java b/api/src/main/java/edu/cornell/mannlib/vitro/webapp/dwr/EntityDWR.java index 289cf0f45..17cba228e 100755 --- a/api/src/main/java/edu/cornell/mannlib/vitro/webapp/dwr/EntityDWR.java +++ b/api/src/main/java/edu/cornell/mannlib/vitro/webapp/dwr/EntityDWR.java @@ -33,7 +33,7 @@ public class EntityDWR { /** * Insets a new entity into the Vitro system. - * @returns < 1 if failed, entityId if success. + * @return < 1 if failed, entityId if success. */ public String insertNewEntity(Individual ent ){ try { @@ -47,8 +47,6 @@ public class EntityDWR { /** ******************************************************** * Gets an Entity object for a given entities.id. - * @param entityId - * @return */ public Individual entityByURI(String entityURI){ WebContext ctx = WebContextFactory.get(); diff --git a/api/src/main/java/edu/cornell/mannlib/vitro/webapp/dwr/PropertyDWR.java b/api/src/main/java/edu/cornell/mannlib/vitro/webapp/dwr/PropertyDWR.java index 038a887ba..94caff72b 100755 --- a/api/src/main/java/edu/cornell/mannlib/vitro/webapp/dwr/PropertyDWR.java +++ b/api/src/main/java/edu/cornell/mannlib/vitro/webapp/dwr/PropertyDWR.java @@ -49,7 +49,7 @@ public class PropertyDWR { /** * Gets only unhidden properties. - * @returns Collection of PropertyInstance objs + * @return Collection of PropertyInstance objs */ public Collection getAllPropInstByVClass(String classURI){ WebContext ctx = WebContextFactory.get(); diff --git a/api/src/main/java/edu/cornell/mannlib/vitro/webapp/dwr/VClassDWR.java b/api/src/main/java/edu/cornell/mannlib/vitro/webapp/dwr/VClassDWR.java index c9563e54d..d93e75756 100644 --- a/api/src/main/java/edu/cornell/mannlib/vitro/webapp/dwr/VClassDWR.java +++ b/api/src/main/java/edu/cornell/mannlib/vitro/webapp/dwr/VClassDWR.java @@ -28,8 +28,8 @@ public class VClassDWR { * add proprties form. * * - * @param vclassId - vclass we want to make a property for - * @param propertyId - property we want to use + * @param vclassURI - vclass we want to make a property for + * @param propertyURI - property we want to use * @param filterOutUninstanciated - if true filter out any vclasses with zero instances. * @return a list of VClass objects, one for each vclass that could be in the * relation indicated by the parameters. diff --git a/api/src/main/java/edu/cornell/mannlib/vitro/webapp/edit/n3editing/VTwo/DateTimeWithPrecisionVTwo.java b/api/src/main/java/edu/cornell/mannlib/vitro/webapp/edit/n3editing/VTwo/DateTimeWithPrecisionVTwo.java index d4dbc8669..5e6b65c65 100644 --- a/api/src/main/java/edu/cornell/mannlib/vitro/webapp/edit/n3editing/VTwo/DateTimeWithPrecisionVTwo.java +++ b/api/src/main/java/edu/cornell/mannlib/vitro/webapp/edit/n3editing/VTwo/DateTimeWithPrecisionVTwo.java @@ -26,7 +26,7 @@ import freemarker.template.Configuration; /** * This is intended to work in conjunction with a template to create the HTML for a * datetime with precision and to convert the submitted parameters into - * varname -> Literal and varname -> URI maps. + * varname -> Literal and varname -> URI maps. * * The variables that get passed to the template are defined in: * DateTimeWithPrecision.getMapForTemplate() diff --git a/api/src/main/java/edu/cornell/mannlib/vitro/webapp/edit/n3editing/VTwo/EditConfigurationUtils.java b/api/src/main/java/edu/cornell/mannlib/vitro/webapp/edit/n3editing/VTwo/EditConfigurationUtils.java index a445b091c..2227eec5d 100644 --- a/api/src/main/java/edu/cornell/mannlib/vitro/webapp/edit/n3editing/VTwo/EditConfigurationUtils.java +++ b/api/src/main/java/edu/cornell/mannlib/vitro/webapp/edit/n3editing/VTwo/EditConfigurationUtils.java @@ -302,7 +302,6 @@ public class EditConfigurationUtils { return copyList; } - /** Make a copy of a Map */ public static Map copyMap(Map source) { HashMap map = new HashMap(); Set keys = map.keySet(); @@ -315,7 +314,6 @@ public class EditConfigurationUtils { return map; } - /** Make a copy of a Map> */ public static Map> copyListMap(Map> source) { HashMap> map = new HashMap>(); Set keys = map.keySet(); @@ -326,7 +324,6 @@ public class EditConfigurationUtils { return map; } - public static EditConfigurationVTwo getEditConfiguration(HttpServletRequest request) { HttpSession session = request.getSession(); EditConfigurationVTwo editConfiguration = EditConfigurationVTwo.getConfigFromSession(session, request); diff --git a/api/src/main/java/edu/cornell/mannlib/vitro/webapp/edit/n3editing/VTwo/EditConfigurationVTwo.java b/api/src/main/java/edu/cornell/mannlib/vitro/webapp/edit/n3editing/VTwo/EditConfigurationVTwo.java index 0d214060a..7eb33bc0e 100644 --- a/api/src/main/java/edu/cornell/mannlib/vitro/webapp/edit/n3editing/VTwo/EditConfigurationVTwo.java +++ b/api/src/main/java/edu/cornell/mannlib/vitro/webapp/edit/n3editing/VTwo/EditConfigurationVTwo.java @@ -449,7 +449,6 @@ public class EditConfigurationVTwo { } /** Return a copy of the value so that the configuration is not modified by external code. - * @return */ public List getN3Required() { return EditConfigurationUtils.copy(n3Required); @@ -471,7 +470,6 @@ public class EditConfigurationVTwo { this.n3Required.addAll(Arrays.asList( n3RequiredStrsInput )); } /** return a copy of the value so that the configuration is not modified by external code. - * @return */ public List getN3Optional() { return EditConfigurationUtils.copy( n3Optional ); @@ -600,7 +598,6 @@ public class EditConfigurationVTwo { } /** Return a copy of the value so that the configuration is not modified by external code. - * @return */ public Map getSparqlForAdditionalUrisInScope() { return copyMap(sparqlForAdditionalUrisInScope); @@ -611,7 +608,6 @@ public class EditConfigurationVTwo { } /** Return a copy of the value so that the configuration is not modified by external code. - * @return */ public Map getSparqlForAdditionalLiteralsInScope() { return copyMap(sparqlForAdditionalLiteralsInScope); @@ -650,7 +646,6 @@ public class EditConfigurationVTwo { } /** return a copy of the value so that the configuration is not modified by external code. - * @return */ public Map getSparqlForExistingLiterals() { return copyMap(sparqlForExistingLiterals); @@ -661,7 +656,6 @@ public class EditConfigurationVTwo { } /** return a copy of the value so that the configuration is not modified by external code. - * @return */ public Map getSparqlForExistingUris() { return copyMap(sparqlForExistingUris); diff --git a/api/src/main/java/edu/cornell/mannlib/vitro/webapp/edit/n3editing/VTwo/EditN3GeneratorVTwo.java b/api/src/main/java/edu/cornell/mannlib/vitro/webapp/edit/n3editing/VTwo/EditN3GeneratorVTwo.java index 39ea3f3b0..980b538da 100644 --- a/api/src/main/java/edu/cornell/mannlib/vitro/webapp/edit/n3editing/VTwo/EditN3GeneratorVTwo.java +++ b/api/src/main/java/edu/cornell/mannlib/vitro/webapp/edit/n3editing/VTwo/EditN3GeneratorVTwo.java @@ -34,7 +34,7 @@ public class EditN3GeneratorVTwo { * This takes into account multiple values that would be returned from a select list. * subInUris should no longer be used. * - * It's important that the map contain String to List mapping. + * It's important that the map contain String to List<String> mapping. * * Before values are sent in, all of the values for a variable should be placed within an array. * diff --git a/api/src/main/java/edu/cornell/mannlib/vitro/webapp/edit/n3editing/VTwo/MultiValueEditSubmission.java b/api/src/main/java/edu/cornell/mannlib/vitro/webapp/edit/n3editing/VTwo/MultiValueEditSubmission.java index abbbe7505..cf154f679 100644 --- a/api/src/main/java/edu/cornell/mannlib/vitro/webapp/edit/n3editing/VTwo/MultiValueEditSubmission.java +++ b/api/src/main/java/edu/cornell/mannlib/vitro/webapp/edit/n3editing/VTwo/MultiValueEditSubmission.java @@ -179,7 +179,7 @@ public class MultiValueEditSubmission { } /** * need to generate something like - * "09:10:11"^^ + * {@code "09:10:11"^^} */ public Literal getTime(Map queryParameters,String fieldName) { List hour = Arrays.asList(queryParameters.get("hour" + fieldName)); diff --git a/api/src/main/java/edu/cornell/mannlib/vitro/webapp/edit/n3editing/VTwo/N3EditUtils.java b/api/src/main/java/edu/cornell/mannlib/vitro/webapp/edit/n3editing/VTwo/N3EditUtils.java index df0189e31..99f9675f9 100644 --- a/api/src/main/java/edu/cornell/mannlib/vitro/webapp/edit/n3editing/VTwo/N3EditUtils.java +++ b/api/src/main/java/edu/cornell/mannlib/vitro/webapp/edit/n3editing/VTwo/N3EditUtils.java @@ -247,8 +247,7 @@ public class N3EditUtils { /** * Strips from a string any characters that are not valid in XML 1.0 - * @param in - * @return + * @param in String to strip characters from */ public static String stripInvalidXMLChars(String in) { if (in == null) { diff --git a/api/src/main/java/edu/cornell/mannlib/vitro/webapp/edit/n3editing/VTwo/ProcessRdfForm.java b/api/src/main/java/edu/cornell/mannlib/vitro/webapp/edit/n3editing/VTwo/ProcessRdfForm.java index 89fffd900..08f5d2d84 100644 --- a/api/src/main/java/edu/cornell/mannlib/vitro/webapp/edit/n3editing/VTwo/ProcessRdfForm.java +++ b/api/src/main/java/edu/cornell/mannlib/vitro/webapp/edit/n3editing/VTwo/ProcessRdfForm.java @@ -274,7 +274,7 @@ public class ProcessRdfForm { /** * Parse the n3Strings to a List of RDF Model objects. * - * @param n3Strings + * @param n3Strings N3 Strings to parse * @param parseType if OPTIONAL, then don't throw exceptions on errors * If REQUIRED, then throw exceptions on errors. * @throws Exception diff --git a/api/src/main/java/edu/cornell/mannlib/vitro/webapp/edit/n3editing/VTwo/RdfLiteralHash.java b/api/src/main/java/edu/cornell/mannlib/vitro/webapp/edit/n3editing/VTwo/RdfLiteralHash.java index 8cffd9847..415bbfab7 100644 --- a/api/src/main/java/edu/cornell/mannlib/vitro/webapp/edit/n3editing/VTwo/RdfLiteralHash.java +++ b/api/src/main/java/edu/cornell/mannlib/vitro/webapp/edit/n3editing/VTwo/RdfLiteralHash.java @@ -23,7 +23,7 @@ import edu.cornell.mannlib.vitro.webapp.dao.VitroVocabulary; * RDF literal statement without including the whole literal in the parameters. * * ex. - * http://fake.com/delete?sub="http://bob"&pred="http://hasNickName"&stmtHash="23443434" + * {@code http://fake.com/delete?sub="http://bob"&pred="http://hasNickName"&stmtHash="23443434"} * * This could request the deletion of a the statement for Bob's nickname where the * literal matched the hash 23443434. @@ -39,7 +39,7 @@ public class RdfLiteralHash { /** * Make a hash based on individual, property, literal and (lang or datatype). * - * @param stmt + * @param stmt Data statement * @return a value between MIN_INTEGER and MAX_INTEGER */ public static int makeRdfLiteralHash( DataPropertyStatement stmt ){ @@ -72,9 +72,8 @@ public class RdfLiteralHash { /** - * @param stmt - * @param hash - * @return + * @param stmt Data statement + * @param hash Hash */ public static boolean doesStmtMatchHash( DataPropertyStatement stmt, int hash){ if( stmt == null ) @@ -92,9 +91,9 @@ public class RdfLiteralHash { /** * Forward to either getDataPropertyStmtByHash or getRdfsLabelStatementByHash, depending on the property. - * @param subjectUri, - * @param predicateUri, - * @param hash + * @param subjectUri Subject URI + * @param predicateUri Predicate URI + * @param hash Hash * @param model, may not be null * @return a DataPropertyStatement if found or null if not found */ diff --git a/api/src/main/java/edu/cornell/mannlib/vitro/webapp/edit/n3editing/VTwo/fields/FieldOptions.java b/api/src/main/java/edu/cornell/mannlib/vitro/webapp/edit/n3editing/VTwo/fields/FieldOptions.java index 12f2182c4..8a9251a03 100644 --- a/api/src/main/java/edu/cornell/mannlib/vitro/webapp/edit/n3editing/VTwo/fields/FieldOptions.java +++ b/api/src/main/java/edu/cornell/mannlib/vitro/webapp/edit/n3editing/VTwo/fields/FieldOptions.java @@ -20,7 +20,7 @@ public interface FieldOptions { * Any object that are needed to get the options should * be passed in the constructor of the implementation. * - * @return return a map of value->label for the options. + * @return return a map of value->label for the options. * Should never return null. * * @throws Exception diff --git a/api/src/main/java/edu/cornell/mannlib/vitro/webapp/edit/n3editing/controller/PostEditCleanupController.java b/api/src/main/java/edu/cornell/mannlib/vitro/webapp/edit/n3editing/controller/PostEditCleanupController.java index dff0cae1d..7409da04a 100644 --- a/api/src/main/java/edu/cornell/mannlib/vitro/webapp/edit/n3editing/controller/PostEditCleanupController.java +++ b/api/src/main/java/edu/cornell/mannlib/vitro/webapp/edit/n3editing/controller/PostEditCleanupController.java @@ -46,7 +46,6 @@ public class PostEditCleanupController extends FreemarkerHttpServlet{ * Returns a redirect after an edit. * @param vreq - should have an edit configuration in attributes or session * @param entityToReturnTo - may be null - * @return */ protected static ResponseValues doPostEditRedirect( VitroRequest vreq , String entityToReturnTo){ EditConfigurationVTwo editConfig = EditConfigurationVTwo.getConfigFromSession(vreq.getSession(), vreq); diff --git a/api/src/main/java/edu/cornell/mannlib/vitro/webapp/filestorage/FileServingHelper.java b/api/src/main/java/edu/cornell/mannlib/vitro/webapp/filestorage/FileServingHelper.java index ab8da1fcb..17cc446f2 100644 --- a/api/src/main/java/edu/cornell/mannlib/vitro/webapp/filestorage/FileServingHelper.java +++ b/api/src/main/java/edu/cornell/mannlib/vitro/webapp/filestorage/FileServingHelper.java @@ -106,7 +106,7 @@ public class FileServingHelper { * replacing the file prefix with the default namespace. *

* - * @return the URI, or null if the URL couldn't be translated. + * @return the URI, or {@code null} if the URL couldn't be translated. */ public static String getBytestreamUri(String path, ServletContext ctx) { if (path == null) { diff --git a/api/src/main/java/edu/cornell/mannlib/vitro/webapp/filestorage/TempFileHolder.java b/api/src/main/java/edu/cornell/mannlib/vitro/webapp/filestorage/TempFileHolder.java index e0ad95c58..ffc790290 100644 --- a/api/src/main/java/edu/cornell/mannlib/vitro/webapp/filestorage/TempFileHolder.java +++ b/api/src/main/java/edu/cornell/mannlib/vitro/webapp/filestorage/TempFileHolder.java @@ -31,7 +31,7 @@ public class TempFileHolder implements HttpSessionBindingListener { private static final Log log = LogFactory.getLog(TempFileHolder.class); /** - * Create a {@link TempFileHolder} holding the given {@link FileInfo}, and + * Create a holding the given {@link FileInfo}, and * attach it to the session with the given attribute name. * * If an attribute with this name already exists, it is replaced. @@ -52,11 +52,11 @@ public class TempFileHolder implements HttpSessionBindingListener { } /** - * Get the {@link TempFileHolder} which is stored as an attribute on this + * Get the which is stored as an attribute on this * session, extract the {@link FileInfo} from it, and remove it from the * session. * - * If there is no such attribute, of if it is not a {@link TempFileHolder}, + * If there is no such attribute, of if it is not a , * return null. */ public static FileInfo remove(HttpSession session, String attributeName) { @@ -92,8 +92,6 @@ public class TempFileHolder implements HttpSessionBindingListener { /** * Gets the {@link FileInfo} payload, and removes it so the file won't be * deleted when the value is unbound. - * - * @return */ private FileInfo extractFileInfo() { FileInfo result = this.fileInfo; @@ -103,8 +101,7 @@ public class TempFileHolder implements HttpSessionBindingListener { /** * When attached to the session, do nothing. - * - * @see HttpSessionBindingListener#valueBound(HttpSessionBindingEvent) + * */ @Override public void valueBound(HttpSessionBindingEvent event) { @@ -115,8 +112,7 @@ public class TempFileHolder implements HttpSessionBindingListener { * When removed from the session, if the {@link #fileInfo} is not empty, * delete the file. If you had wanted this file, you should have called * {@link #remove(HttpSession, String) remove}. - * - * @see HttpSessionBindingListener#valueUnbound(HttpSessionBindingEvent) + * */ @Override public void valueUnbound(HttpSessionBindingEvent event) { diff --git a/api/src/main/java/edu/cornell/mannlib/vitro/webapp/filestorage/impl/FileStorageHelper.java b/api/src/main/java/edu/cornell/mannlib/vitro/webapp/filestorage/impl/FileStorageHelper.java index 717d2ce0c..477077fcb 100644 --- a/api/src/main/java/edu/cornell/mannlib/vitro/webapp/filestorage/impl/FileStorageHelper.java +++ b/api/src/main/java/edu/cornell/mannlib/vitro/webapp/filestorage/impl/FileStorageHelper.java @@ -54,8 +54,6 @@ public class FileStorageHelper { /** * Encode the filename as needed to guard against illegal characters. - * - * @see edu.cornell.mannlib.vitro.webapp.utils.filestorage */ public static String encodeName(String filename) { String hexed = addHexEncoding(filename); @@ -149,8 +147,6 @@ public class FileStorageHelper { /** * Restore the filename to its original form, removing the encoding. - * - * @see edu.cornell.mannlib.vitro.webapp.utils.filestorage */ public static String decodeName(String stored) { String unexcluded = unexcludeWindowsReservedNames(stored); @@ -228,8 +224,6 @@ public class FileStorageHelper { * namespace is translated to its prefix, and illegal characters are * encoded. The resulting string is broken up into 3-character directory * names (or less). Windows reserved words are prefixed with tilde. - * - * @see edu.cornell.mannlib.vitro.webapp.utils.filestorage */ public static String id2Path(String id, Map namespacesMap) { char prefix = 0; @@ -305,8 +299,6 @@ public class FileStorageHelper { /** * Translate the object ID and the file storage root directory into a full * path to the directory that would represent that ID. - * - * @see edu.cornell.mannlib.vitro.webapp.utils.filestorage */ public static File getPathToIdDirectory(String id, Map namespacesMap, File rootDir) { @@ -316,8 +308,6 @@ public class FileStorageHelper { /** * Translate the object ID, the file storage root directory and the filename * into a full path to where the file would be stored. - * - * @see edu.cornell.mannlib.vitro.webapp.utils.filestorage */ public static File getFullPath(File rootDir, String id, String filename, Map namespacesMap) { diff --git a/api/src/main/java/edu/cornell/mannlib/vitro/webapp/filestorage/impl/FileStorageImpl.java b/api/src/main/java/edu/cornell/mannlib/vitro/webapp/filestorage/impl/FileStorageImpl.java index c02dfbcd3..6eab38aca 100644 --- a/api/src/main/java/edu/cornell/mannlib/vitro/webapp/filestorage/impl/FileStorageImpl.java +++ b/api/src/main/java/edu/cornell/mannlib/vitro/webapp/filestorage/impl/FileStorageImpl.java @@ -252,8 +252,6 @@ public class FileStorageImpl { // ---------------------------------------------------------------------- /** - * {@inheritDoc} - * *

* Before creating the file, we may need to create one or more parent * directories to put it in. @@ -302,8 +300,6 @@ public class FileStorageImpl { } /** - * {@inheritDoc} - * *

* If deleting this file leaves its parent directory empty, that directory * will be deleted. This repeats, up to (but not including) the root @@ -409,7 +405,6 @@ public class FileStorageImpl { } /** - * {@inheritDoc} */ public InputStream getInputStream(String id, String filename) throws IOException { diff --git a/api/src/main/java/edu/cornell/mannlib/vitro/webapp/filestorage/impl/package-info.java b/api/src/main/java/edu/cornell/mannlib/vitro/webapp/filestorage/impl/package-info.java index 386f40f4d..588a71a52 100644 --- a/api/src/main/java/edu/cornell/mannlib/vitro/webapp/filestorage/impl/package-info.java +++ b/api/src/main/java/edu/cornell/mannlib/vitro/webapp/filestorage/impl/package-info.java @@ -6,6 +6,7 @@ *

Relationship to PairTree

*

* The system incorporates a number of ideas from the PairTree specification, + *

*
    *
  • * The basic pairtree algorithm - @@ -45,18 +46,17 @@ * "shorty" directory names may be up to 3 characters long, not 2. *
    • *
- *

*

Directory structure

*

* A typical structure would look like this: - * 

+ * {@code
  * + basedir
  * |
  * +--+ file_storage_namespaces.properties
  * |
  * +--+ file_storage_root
- *
- * The file_storage_root directory contains the subdirectories + * } + * The {@code file_storage_root} directory contains the subdirectories * that implement the encoded IDs, and the final directory for each ID will * contain a single file that corresponds to that ID. *

@@ -71,23 +71,24 @@ * For example, the sytem might be initialized with a "namespace" of * "http://vivo.mydomain.edu/file/". If that is the only namespace, it will * be internally assigned a prefix of "a", so a URI like this: + *

* 
http://vivo.mydomain.edu/file/n3424/myPhoto.jpg
* would be converted to this: * 
a~n3424/myPhoto.jpg
- *

*

* The namespaces and their assigned prefixes are stored in a properties file * when the structure is initialized. When the structure is re-opened, the * file is read to find the correct prefixes. The file * might look like this: + *

* 
  * a = http://the.first.namespace/
  * b = http://the.second.namespace/
  *
- *

*

ID encoding

*

* This is a multi-step process: + *

*
    *
  • * Namespace recognition - @@ -139,17 +140,12 @@ *
    • *
* Examples: - *
ark:/13030/xt12t3 becomes - * ark/+=1/303/0=x/t12/t3 - *
http://n2t.info/urn:nbn:se:kb:repos-1 becomes - * htt/p+=/=n2/t,i/nfo/=ur/n+n/bn+/se+/kb+/rep/os-/1 - *
what-the-*@?#!^!~? becomes - * wha/t-t/he-/^2a/@^3/f#!/^5e/!^7/e^3/f - *
http://vivo.myDomain.edu/file/n3424 with namespace - * http://vivo.myDomain.edu/file/ and prefix - * a becomes - * a~n/342/4 - *

+ * {@code ark:/13030/xt12t3} becomes {@code ark/+=1/303/0=x/t12/t3} + * {@code http://n2t.info/urn:nbn:se:kb:repos-1} becomes {@code htt/p+=/=n2/t,i/nfo/=ur/n+n/bn+/se+/kb+/rep/os-/1} + * {@code what-the-*@?#!^!~?} becomes {@code wha/t-t/he-/^2a/@^3/f#!/^5e/!^7/e^3/f} + * {@code http://vivo.myDomain.edu/file/n3424} with namespace + * {@code http://vivo.myDomain.edu/file/} and prefix + * {@code a} becomes {@code a~n/342/4} *

Filename encoding

*

* The name of the file is encoded as needed to guard against illegal @@ -161,9 +157,6 @@ * "common character encoding" steps used for ID encoding, except that * periods are not encoded. *

- *
- *
- *
*

* This was summarized in a post to the vivo-dev-all list on 11/29/2010 *

@@ -186,19 +179,19 @@ *

*

* Let's consider a file with this information: + *

* 
  * 		URI = http://vivo.mydomain.edu/individual/n3156
  * 		Filename = lily1.jpg
  *
- *

*

* We want to turn the URI into the directory path, but the URI contains * prohibited characters. Using a PairTree-like character substitution, * we might store it at this path: + *

* 
  * 		/usr/local/vivo/uploads/file_storage_root/http+==vivo.mydomain.edu=individual=n3156/lily1.jpg
  *
- *

*

* Using that scheme would mean that each file sits in its own directory * under the storage root. At a large institution, there might be hundreds of @@ -212,15 +205,16 @@ * per directory. In practice, the number will be considerably smaller. * * So then it would look like this: + *

* 
  * 		/usr/local/vivo/uploads/file_storage_root/htt/p+=/=vi/vo./myd/oma/in./edu/=in/div/idu/al=/n31/56/lily1.jpg
  *
- *

*

* But almost all of our URIs will start with the same namespace, so the * namespace just adds unnecessary and unhelpful depth to the directory tree. * We assign a single-character prefix to that namespace, using the * file_storage_namespaces.properties file in the uploads directory, like this: + *

* 
  * 		a = http://vivo.mydomain.edu/individual/
  *
@@ -232,9 +226,9 @@ * 
  * 		/usr/local/vivo/uploads/file_storage_root/a~n/315/6/lily1.jpg
  *
- *

*

* So what we hope we have implemented is a system where: + *

*
    *
  • Files are stored by URI and filename.
    • *
  • File paths are constructed to limit the maximum number of files in a directory.
    • @@ -244,9 +238,9 @@ *
  • Frequently-used namespaces on the URIs can be collapsed to short prefix sequences.
    • *
  • URIs with unrecognized namespaces will not cause problems.
    • *
- *

*

* By the way, almost all of this is implemented in + *

* 
  * 		edu.cornell.mannlib.vitro.webapp.filestorage.impl.FileStorageHelper
  *
@@ -254,6 +248,5 @@ * 
  * 		edu.cornell.mannlib.vitro.webapp.filestorage.impl.FileStorageHelperTest
  *
- *

*/ package edu.cornell.mannlib.vitro.webapp.filestorage.impl; \ No newline at end of file diff --git a/api/src/main/java/edu/cornell/mannlib/vitro/webapp/filestorage/serving/FileServingServlet.java b/api/src/main/java/edu/cornell/mannlib/vitro/webapp/filestorage/serving/FileServingServlet.java index 8ee917595..33a4d1b67 100644 --- a/api/src/main/java/edu/cornell/mannlib/vitro/webapp/filestorage/serving/FileServingServlet.java +++ b/api/src/main/java/edu/cornell/mannlib/vitro/webapp/filestorage/serving/FileServingServlet.java @@ -32,13 +32,13 @@ import edu.cornell.mannlib.vitro.webapp.modules.fileStorage.FileStorage; *

* The path of the request should be the "alias URL" of the desired file. We * need to: + *

*
    *
  • Use the alias URL to find the URI of the file bytestream object.
    • *
  • Find the file surrogate object to get the MIME type of the file, and * confirm the filename.
    • *
  • Set the MIME type on the output stream and serve the bytes.
    • *
- *

*

* If the request is superficially correct, but no such file can be found, * return a 404. If there is a break in the data structures within the model or diff --git a/api/src/main/java/edu/cornell/mannlib/vitro/webapp/filters/CachingResponseFilter.java b/api/src/main/java/edu/cornell/mannlib/vitro/webapp/filters/CachingResponseFilter.java index 15312195a..cb4f5e39c 100644 --- a/api/src/main/java/edu/cornell/mannlib/vitro/webapp/filters/CachingResponseFilter.java +++ b/api/src/main/java/edu/cornell/mannlib/vitro/webapp/filters/CachingResponseFilter.java @@ -66,8 +66,6 @@ import edu.cornell.mannlib.vitro.webapp.utils.searchengine.SearchResultsParser; * * An unconditional request may mean that there is no external cache, or that * the cache doesn't have a copy of this particular page. - * - * @see http://tools.ietf.org/pdf/rfc2616 */ public class CachingResponseFilter implements Filter { private static final Log log = LogFactory diff --git a/api/src/main/java/edu/cornell/mannlib/vitro/webapp/filters/JSessionStripFilter.java b/api/src/main/java/edu/cornell/mannlib/vitro/webapp/filters/JSessionStripFilter.java index 08d4bb507..6f22d8d19 100644 --- a/api/src/main/java/edu/cornell/mannlib/vitro/webapp/filters/JSessionStripFilter.java +++ b/api/src/main/java/edu/cornell/mannlib/vitro/webapp/filters/JSessionStripFilter.java @@ -22,6 +22,7 @@ import org.apache.commons.logging.LogFactory; * Here is what needs to go into the web.xml: * + * {@code JSession Strip Filter edu.cornell.mannlib.vitro.filters.JSessionStripFilter @@ -32,7 +33,7 @@ import org.apache.commons.logging.LogFactory; /* REQUEST - + } * some of this code is from URLRewriteFilter */ public class JSessionStripFilter implements Filter { diff --git a/api/src/main/java/edu/cornell/mannlib/vitro/webapp/filters/VitroURL.java b/api/src/main/java/edu/cornell/mannlib/vitro/webapp/filters/VitroURL.java index 575625e39..ba5b2d03f 100644 --- a/api/src/main/java/edu/cornell/mannlib/vitro/webapp/filters/VitroURL.java +++ b/api/src/main/java/edu/cornell/mannlib/vitro/webapp/filters/VitroURL.java @@ -156,9 +156,8 @@ class VitroURL { * This seems like a huge problem. We will only correctly handle odd things * as a query parameter 'uri' in the last position. * - * @param queryStr - * @return - */ + * @param queryStr Querst string + */ protected List parseQueryParams(String queryStr) { List queryParamList = new ArrayList(); if (queryStr == null) { diff --git a/api/src/main/java/edu/cornell/mannlib/vitro/webapp/i18n/VitroResourceBundle.java b/api/src/main/java/edu/cornell/mannlib/vitro/webapp/i18n/VitroResourceBundle.java index 93a7131ca..5ac0cdb35 100644 --- a/api/src/main/java/edu/cornell/mannlib/vitro/webapp/i18n/VitroResourceBundle.java +++ b/api/src/main/java/edu/cornell/mannlib/vitro/webapp/i18n/VitroResourceBundle.java @@ -30,7 +30,7 @@ import org.apache.commons.logging.LogFactory; * relative to the i18n directory. Again, a file in the theme will override one * in the application. * - * If a property has a value (after overriding) of "@@file ", the + * If a property has a value (after overriding) of "@@file <filepath>", the * bundle looks for the file relative to the i18n directory of the theme, then * relative to the i18n directory of the application. If the file is not found * in either location, a warning is written to the log and the property will diff --git a/api/src/main/java/edu/cornell/mannlib/vitro/webapp/i18n/freemarker/I18nStringTemplateModel.java b/api/src/main/java/edu/cornell/mannlib/vitro/webapp/i18n/freemarker/I18nStringTemplateModel.java index e11ae6640..a93ad7ad1 100644 --- a/api/src/main/java/edu/cornell/mannlib/vitro/webapp/i18n/freemarker/I18nStringTemplateModel.java +++ b/api/src/main/java/edu/cornell/mannlib/vitro/webapp/i18n/freemarker/I18nStringTemplateModel.java @@ -20,11 +20,11 @@ import freemarker.template.utility.DeepUnwrap; * implements TemplateMethodModel, you can pass arguments to it for formatting. * * So if the string is "His name is {0}!", then these references could be used: - * + * {@code * ${string} ==> "His name is {0}!" * * ${string("Bozo")} ==> "His name is Bozo!" - * + * } * Note that the format of the message is determined by java.text.MessageFormat, * so argument indices start at 0 and you can escape a substring by wrapping it * in apostrophes. diff --git a/api/src/main/java/edu/cornell/mannlib/vitro/webapp/i18n/selection/LocaleSelectionController.java b/api/src/main/java/edu/cornell/mannlib/vitro/webapp/i18n/selection/LocaleSelectionController.java index 76bf70012..f57139fb3 100644 --- a/api/src/main/java/edu/cornell/mannlib/vitro/webapp/i18n/selection/LocaleSelectionController.java +++ b/api/src/main/java/edu/cornell/mannlib/vitro/webapp/i18n/selection/LocaleSelectionController.java @@ -21,10 +21,11 @@ import edu.cornell.mannlib.vitro.webapp.controller.freemarker.UrlBuilder; import edu.cornell.mannlib.vitro.webapp.i18n.I18n; /** + * {@code * Call this at /selectLocale&selection=[locale_string] * * For example: /selectLocale&selection=en_US or /selectLocale&selection=es - * + * } * Write an error to the log (and to DisplayMessage) if the selection is not * syntactically valid. * diff --git a/api/src/main/java/edu/cornell/mannlib/vitro/webapp/modules/fileStorage/FileStorage.java b/api/src/main/java/edu/cornell/mannlib/vitro/webapp/modules/fileStorage/FileStorage.java index 51f4d86ed..218104283 100644 --- a/api/src/main/java/edu/cornell/mannlib/vitro/webapp/modules/fileStorage/FileStorage.java +++ b/api/src/main/java/edu/cornell/mannlib/vitro/webapp/modules/fileStorage/FileStorage.java @@ -28,7 +28,7 @@ public interface FileStorage extends Application.Module { * If a file exists with this ID, get its name. * * @return The name of the file (un-encoded) if it exists, or - * null if it does not. + * {@code null} if it does not. */ String getFilename(String id) throws IOException; @@ -47,7 +47,7 @@ public interface FileStorage extends Application.Module { * If a file exists with this ID, it will be deleted, regardless of the file * name. If no such file exists, no action is taken, no exception is thrown. * - * @return true if a file existed, false otherwise. + * @return {@code true} if a file existed, {@code false} otherwise. */ boolean deleteFile(String id) throws IOException; } diff --git a/api/src/main/java/edu/cornell/mannlib/vitro/webapp/modules/searchEngine/SearchResultDocumentList.java b/api/src/main/java/edu/cornell/mannlib/vitro/webapp/modules/searchEngine/SearchResultDocumentList.java index 83915339a..f5958e48b 100644 --- a/api/src/main/java/edu/cornell/mannlib/vitro/webapp/modules/searchEngine/SearchResultDocumentList.java +++ b/api/src/main/java/edu/cornell/mannlib/vitro/webapp/modules/searchEngine/SearchResultDocumentList.java @@ -22,7 +22,6 @@ public interface SearchResultDocumentList extends * Retrieve the i'th document, starting with 0. * * @throws ArrayIndexOutOfBoundsException - * if i < 0 or i >= size() */ SearchResultDocument get(int i); diff --git a/api/src/main/java/edu/cornell/mannlib/vitro/webapp/modules/searchIndexer/SearchIndexer.java b/api/src/main/java/edu/cornell/mannlib/vitro/webapp/modules/searchIndexer/SearchIndexer.java index 5f7657379..fa40b384a 100644 --- a/api/src/main/java/edu/cornell/mannlib/vitro/webapp/modules/searchIndexer/SearchIndexer.java +++ b/api/src/main/java/edu/cornell/mannlib/vitro/webapp/modules/searchIndexer/SearchIndexer.java @@ -77,7 +77,7 @@ public interface SearchIndexer extends Application.Module { * If called before startup or while paused, the task will be queued. If * called after shutdown, this has no effect. * - * @param urls + * @param changes * if null or empty, this call has no effect. */ void scheduleUpdatesForStatements(List changes); diff --git a/api/src/main/java/edu/cornell/mannlib/vitro/webapp/ontology/update/ABoxUpdater.java b/api/src/main/java/edu/cornell/mannlib/vitro/webapp/ontology/update/ABoxUpdater.java index 00e854d83..c8d38c158 100644 --- a/api/src/main/java/edu/cornell/mannlib/vitro/webapp/ontology/update/ABoxUpdater.java +++ b/api/src/main/java/edu/cornell/mannlib/vitro/webapp/ontology/update/ABoxUpdater.java @@ -55,9 +55,7 @@ public class ABoxUpdater { * * Constructor * - * @param oldTboxModel - previous version of the ontology - * @param newTboxModel - new version of the ontology - * @param aboxModel - the knowledge base to be updated + * @param settings - Update settings * @param logger - for writing to the change log * and the error log. * @param record - for writing to the additions model diff --git a/api/src/main/java/edu/cornell/mannlib/vitro/webapp/ontology/update/AtomicOntologyChange.java b/api/src/main/java/edu/cornell/mannlib/vitro/webapp/ontology/update/AtomicOntologyChange.java index 4fbab936d..57bf420bb 100644 --- a/api/src/main/java/edu/cornell/mannlib/vitro/webapp/ontology/update/AtomicOntologyChange.java +++ b/api/src/main/java/edu/cornell/mannlib/vitro/webapp/ontology/update/AtomicOntologyChange.java @@ -40,7 +40,6 @@ public class AtomicOntologyChange { * Contains the URI of a class or property in the previous version of * the ontology, or null if a new class or property was introduced * in the current version of the ontology. - * @return */ public String getSourceURI() { return this.sourceURI; @@ -54,7 +53,6 @@ public class AtomicOntologyChange { * Contains the URI of a class or property in the current version of * the ontology, or null if a class or property was removed from the * previous version of the ontology. - * @return */ public String getDestinationURI() { return this.destinationURI; diff --git a/api/src/main/java/edu/cornell/mannlib/vitro/webapp/ontology/update/KnowledgeBaseUpdater.java b/api/src/main/java/edu/cornell/mannlib/vitro/webapp/ontology/update/KnowledgeBaseUpdater.java index c5d2995be..78545cf06 100644 --- a/api/src/main/java/edu/cornell/mannlib/vitro/webapp/ontology/update/KnowledgeBaseUpdater.java +++ b/api/src/main/java/edu/cornell/mannlib/vitro/webapp/ontology/update/KnowledgeBaseUpdater.java @@ -145,11 +145,10 @@ public class KnowledgeBaseUpdater { * data, for changes that cannot be expressed as simple property * or class additions, deletions, or renamings. * Blank nodes created by the queries are given random URIs. - * @param sparqlConstructDir - * @param readModel - * @param writeModel - * @param add (add = true; retract = false) - */ + * @param sparqlConstructDir Sparql CONSTRUCT + * @param rdfService RDF Service to use + * @param add (add = true; retract = false) + */ private void performSparqlConstructs(String sparqlConstructDir, RDFService rdfService, boolean add) throws IOException { @@ -362,7 +361,7 @@ public class KnowledgeBaseUpdater { /** * loads a SPARQL ASK query from a text file - * @param filePath + * @param filePath Path of a file * @return the query string or null if file not found */ public static String loadSparqlQuery(String filePath) throws IOException { diff --git a/api/src/main/java/edu/cornell/mannlib/vitro/webapp/ontology/update/OntologyChangeParser.java b/api/src/main/java/edu/cornell/mannlib/vitro/webapp/ontology/update/OntologyChangeParser.java index 6a92b213c..fc3327762 100644 --- a/api/src/main/java/edu/cornell/mannlib/vitro/webapp/ontology/update/OntologyChangeParser.java +++ b/api/src/main/java/edu/cornell/mannlib/vitro/webapp/ontology/update/OntologyChangeParser.java @@ -34,7 +34,7 @@ public class OntologyChangeParser { } /** - * @param args + * @param diffPath Diff path * @throws IOException */ diff --git a/api/src/main/java/edu/cornell/mannlib/vitro/webapp/ontology/update/TBoxUpdater.java b/api/src/main/java/edu/cornell/mannlib/vitro/webapp/ontology/update/TBoxUpdater.java index 0d217ea7b..7585fc7eb 100644 --- a/api/src/main/java/edu/cornell/mannlib/vitro/webapp/ontology/update/TBoxUpdater.java +++ b/api/src/main/java/edu/cornell/mannlib/vitro/webapp/ontology/update/TBoxUpdater.java @@ -60,10 +60,8 @@ public class TBoxUpdater { /** * * Constructor - * - * @param oldTboxAnnotationsModel - previous version of the annotations in the ontology - * @param newTboxAnnotationsModel - new version of the annotations in the ontology - * @param siteModel - the knowledge base to be updated + * + * @param settings - update settings * @param logger - for writing to the change log * and the error log. * @param record - for writing to the additions model diff --git a/api/src/main/java/edu/cornell/mannlib/vitro/webapp/rdfservice/ChangeSet.java b/api/src/main/java/edu/cornell/mannlib/vitro/webapp/rdfservice/ChangeSet.java index dc2481939..c4fa9b5f8 100644 --- a/api/src/main/java/edu/cornell/mannlib/vitro/webapp/rdfservice/ChangeSet.java +++ b/api/src/main/java/edu/cornell/mannlib/vitro/webapp/rdfservice/ChangeSet.java @@ -33,8 +33,7 @@ public interface ChangeSet { public void setPreconditionQueryType(RDFService.SPARQLQueryType queryType); /** - * @return List - list of model changes - */ + */ public List getModelChanges(); /** @@ -104,16 +103,12 @@ public interface ChangeSet { /** * Returns a list of events to pass to any change listeners in * advance of the change set additions and retractions being performed. - * - * @return List */ public List getPreChangeEvents(); /** * Returns a list of events to pass to any change listeners after * the change set additions and retractions are performed. - * - * @return List */ public List getPostChangeEvents(); diff --git a/api/src/main/java/edu/cornell/mannlib/vitro/webapp/rdfservice/RDFService.java b/api/src/main/java/edu/cornell/mannlib/vitro/webapp/rdfservice/RDFService.java index 5aa0b9a15..509ab0c7b 100644 --- a/api/src/main/java/edu/cornell/mannlib/vitro/webapp/rdfservice/RDFService.java +++ b/api/src/main/java/edu/cornell/mannlib/vitro/webapp/rdfservice/RDFService.java @@ -141,8 +141,8 @@ public interface RDFService { /** * Returns a list of all the graph URIs in the RDF store. * - * @return List - list of all the named graph URIs in the RDF store. - * Return an empty list of there no named graphs in + * @return list of all the named graph URIs in the RDF store. + * Return an empty list of there no named graphs in * the store. */ public List getGraphURIs() throws RDFServiceException; diff --git a/api/src/main/java/edu/cornell/mannlib/vitro/webapp/rdfservice/ResultSetConsumer.java b/api/src/main/java/edu/cornell/mannlib/vitro/webapp/rdfservice/ResultSetConsumer.java index 46bb7d83e..74d215a6e 100644 --- a/api/src/main/java/edu/cornell/mannlib/vitro/webapp/rdfservice/ResultSetConsumer.java +++ b/api/src/main/java/edu/cornell/mannlib/vitro/webapp/rdfservice/ResultSetConsumer.java @@ -86,7 +86,7 @@ public abstract class ResultSetConsumer { /** * Helper method that calls the processQuerySolution on an embedded ResultSetConsumer - * @param qs + * @param qs Query solution */ protected void chainProcessQuerySolution(QuerySolution qs) { if (innerConsumer != null) { @@ -135,7 +135,6 @@ public abstract class ResultSetConsumer { /** * Were any results found - * @return */ public boolean hasResult() { return hasResult; diff --git a/api/src/main/java/edu/cornell/mannlib/vitro/webapp/rdfservice/impl/RDFServiceImpl.java b/api/src/main/java/edu/cornell/mannlib/vitro/webapp/rdfservice/impl/RDFServiceImpl.java index 0a11d55b7..61bab8e73 100644 --- a/api/src/main/java/edu/cornell/mannlib/vitro/webapp/rdfservice/impl/RDFServiceImpl.java +++ b/api/src/main/java/edu/cornell/mannlib/vitro/webapp/rdfservice/impl/RDFServiceImpl.java @@ -295,8 +295,7 @@ public abstract class RDFServiceImpl implements RDFService { /** * Returns a pair of models. The first contains any statement containing at * least one blank node. The second contains all remaining statements. - * @param g - * @return + * @param gm Jena model */ protected Model[] separateStatementsWithBlankNodes(Model gm) { diff --git a/api/src/main/java/edu/cornell/mannlib/vitro/webapp/rdfservice/impl/jena/model/RDFServiceModel.java b/api/src/main/java/edu/cornell/mannlib/vitro/webapp/rdfservice/impl/jena/model/RDFServiceModel.java index 05bbfa72e..0f9eb5421 100644 --- a/api/src/main/java/edu/cornell/mannlib/vitro/webapp/rdfservice/impl/jena/model/RDFServiceModel.java +++ b/api/src/main/java/edu/cornell/mannlib/vitro/webapp/rdfservice/impl/jena/model/RDFServiceModel.java @@ -30,7 +30,7 @@ public class RDFServiceModel extends RDFServiceJena implements RDFService { /** * Create an RDFService to access a single default graph - * @param model + * @param model Jena Model */ public RDFServiceModel(Model model) { this.model = model; @@ -38,7 +38,7 @@ public class RDFServiceModel extends RDFServiceJena implements RDFService { /** * Create an RDFService to access a Jena Dataset - * @param dataset + * @param dataset Jena Dataset */ public RDFServiceModel(Dataset dataset) { this.dataset = dataset; diff --git a/api/src/main/java/edu/cornell/mannlib/vitro/webapp/rdfservice/impl/sparql/RDFServiceSparql.java b/api/src/main/java/edu/cornell/mannlib/vitro/webapp/rdfservice/impl/sparql/RDFServiceSparql.java index 73fc5e168..bfc7c0aec 100644 --- a/api/src/main/java/edu/cornell/mannlib/vitro/webapp/rdfservice/impl/sparql/RDFServiceSparql.java +++ b/api/src/main/java/edu/cornell/mannlib/vitro/webapp/rdfservice/impl/sparql/RDFServiceSparql.java @@ -92,9 +92,9 @@ public class RDFServiceSparql extends RDFServiceImpl implements RDFService { /** * Returns an RDFService for a remote repository - * @param String - URI of the read SPARQL endpoint for the knowledge base - * @param String - URI of the update SPARQL endpoint for the knowledge base - * @param String - URI of the default write graph within the knowledge base. + * @param readEndpointURI - URI of the read SPARQL endpoint for the knowledge base + * @param updateEndpointURI - URI of the update SPARQL endpoint for the knowledge base + * @param defaultWriteGraphURI - URI of the default write graph within the knowledge base. * this is the graph that will be written to when a graph * is not explicitly specified. * @@ -125,8 +125,8 @@ public class RDFServiceSparql extends RDFServiceImpl implements RDFService { /** * Returns an RDFService for a remote repository - * @param String - URI of the read SPARQL endpoint for the knowledge base - * @param String - URI of the update SPARQL endpoint for the knowledge base + * @param readEndpointURI - URI of the read SPARQL endpoint for the knowledge base + * @param updateEndpointURI - URI of the update SPARQL endpoint for the knowledge base * * The default read graph is the union of all graphs in the * knowledge base @@ -137,7 +137,7 @@ public class RDFServiceSparql extends RDFServiceImpl implements RDFService { /** * Returns an RDFService for a remote repository - * @param String - URI of the read and update SPARQL endpoint for the knowledge base + * @param endpointURI - URI of the read and update SPARQL endpoint for the knowledge base * * The default read graph is the union of all graphs in the * knowledge base @@ -157,7 +157,7 @@ public class RDFServiceSparql extends RDFServiceImpl implements RDFService { * If the precondition query returns a non-empty result no updates * will be made. * - * @param ChangeSet - a set of changes to be performed on the RDF store. + * @param changeSet - a set of changes to be performed on the RDF store. * * @return boolean - indicates whether the precondition was satisfied */ @@ -208,10 +208,8 @@ public class RDFServiceSparql extends RDFServiceImpl implements RDFService { * Performs a SPARQL construct query against the knowledge base. The query may have * an embedded graph identifier. * - * @param String query - the SPARQL query to be executed against the RDF store - * @param RDFService.ModelSerializationFormat resultFormat - type of serialization for RDF result of the SPARQL query - * @param OutputStream outputStream - the result of the query - * + * @param queryStr - the SPARQL query to be executed against the RDF store + * @param resultFormat - type of serialization for RDF result of the SPARQL query */ @Override public InputStream sparqlConstructQuery(String queryStr, @@ -253,8 +251,8 @@ public class RDFServiceSparql extends RDFServiceImpl implements RDFService { * Performs a SPARQL describe query against the knowledge base. The query may have * an embedded graph identifier. * - * @param String query - the SPARQL query to be executed against the RDF store - * @param RDFService.ModelSerializationFormat resultFormat - type of serialization for RDF result of the SPARQL query + * @param queryStr - the SPARQL query to be executed against the RDF store + * @param resultFormat - type of serialization for RDF result of the SPARQL query * * @return InputStream - the result of the query * @@ -283,8 +281,8 @@ public class RDFServiceSparql extends RDFServiceImpl implements RDFService { * Performs a SPARQL select query against the knowledge base. The query may have * an embedded graph identifier. * - * @param String query - the SPARQL query to be executed against the RDF store - * @param RDFService.ResultFormat resultFormat - format for the result of the Select query + * @param queryStr - the SPARQL query to be executed against the RDF store + * @param resultFormat - format for the result of the Select query * * @return InputStream - the result of the query * @@ -374,7 +372,7 @@ public class RDFServiceSparql extends RDFServiceImpl implements RDFService { * Performs a SPARQL ASK query against the knowledge base. The query may have * an embedded graph identifier. * - * @param String query - the SPARQL query to be executed against the RDF store + * @param queryStr - the SPARQL query to be executed against the RDF store * * @return boolean - the result of the SPARQL query */ @@ -393,8 +391,6 @@ public class RDFServiceSparql extends RDFServiceImpl implements RDFService { /** * Get a list of all the graph URIs in the RDF store. - * - * @return List - list of all the graph URIs in the RDF store */ @Override public List getGraphURIs() throws RDFServiceException { @@ -442,8 +438,6 @@ public class RDFServiceSparql extends RDFServiceImpl implements RDFService { } /** - * TODO - what is the definition of this method? - * @return */ @Override public void getGraphMetadata() throws RDFServiceException { diff --git a/api/src/main/java/edu/cornell/mannlib/vitro/webapp/rdfservice/impl/sparql/RDFServiceSparqlHttp.java b/api/src/main/java/edu/cornell/mannlib/vitro/webapp/rdfservice/impl/sparql/RDFServiceSparqlHttp.java index 427cc3bc3..6319bdd9d 100644 --- a/api/src/main/java/edu/cornell/mannlib/vitro/webapp/rdfservice/impl/sparql/RDFServiceSparqlHttp.java +++ b/api/src/main/java/edu/cornell/mannlib/vitro/webapp/rdfservice/impl/sparql/RDFServiceSparqlHttp.java @@ -48,10 +48,8 @@ public class RDFServiceSparqlHttp extends RDFServiceSparql { * Performs a SPARQL construct query against the knowledge base. The query may have * an embedded graph identifier. * - * @param String query - the SPARQL query to be executed against the RDF store - * @param RDFService.ModelSerializationFormat resultFormat - type of serialization for RDF result of the SPARQL query - * @param OutputStream outputStream - the result of the query - * + * @param queryStr - the SPARQL query to be executed against the RDF store + * @param resultFormat - type of serialization for RDF result of the SPARQL query */ @Override public InputStream sparqlConstructQuery(String queryStr, @@ -89,8 +87,8 @@ public class RDFServiceSparqlHttp extends RDFServiceSparql { * Performs a SPARQL describe query against the knowledge base. The query may have * an embedded graph identifier. * - * @param String query - the SPARQL query to be executed against the RDF store - * @param RDFService.ModelSerializationFormat resultFormat - type of serialization for RDF result of the SPARQL query + * @param queryStr - the SPARQL query to be executed against the RDF store + * @param resultFormat - type of serialization for RDF result of the SPARQL query * * @return InputStream - the result of the query * @@ -118,8 +116,8 @@ public class RDFServiceSparqlHttp extends RDFServiceSparql { * Performs a SPARQL select query against the knowledge base. The query may have * an embedded graph identifier. * - * @param String query - the SPARQL query to be executed against the RDF store - * @param RDFService.ResultFormat resultFormat - format for the result of the Select query + * @param queryStr - the SPARQL query to be executed against the RDF store + * @param resultFormat - format for the result of the Select query * * @return InputStream - the result of the query * @@ -174,7 +172,7 @@ public class RDFServiceSparqlHttp extends RDFServiceSparql { * Performs a SPARQL ASK query against the knowledge base. The query may have * an embedded graph identifier. * - * @param String query - the SPARQL query to be executed against the RDF store + * @param queryStr - the SPARQL query to be executed against the RDF store * * @return boolean - the result of the SPARQL query */ diff --git a/api/src/main/java/edu/cornell/mannlib/vitro/webapp/reasoner/ABoxRecomputer.java b/api/src/main/java/edu/cornell/mannlib/vitro/webapp/reasoner/ABoxRecomputer.java index 13c63ccbc..d00692fb4 100644 --- a/api/src/main/java/edu/cornell/mannlib/vitro/webapp/reasoner/ABoxRecomputer.java +++ b/api/src/main/java/edu/cornell/mannlib/vitro/webapp/reasoner/ABoxRecomputer.java @@ -249,8 +249,8 @@ public class ABoxRecomputer { /** * Adds inferences to temporary rebuildmodel - * @param individualURI - * @param rebuildModel + * @param individualURI The individual + * @param rebuildModel The rebuild model * @return any additional inferences produced by plugins that affect other * individuals */ diff --git a/api/src/main/java/edu/cornell/mannlib/vitro/webapp/reasoner/SimpleReasoner.java b/api/src/main/java/edu/cornell/mannlib/vitro/webapp/reasoner/SimpleReasoner.java index e45f1d117..bdcc274b5 100644 --- a/api/src/main/java/edu/cornell/mannlib/vitro/webapp/reasoner/SimpleReasoner.java +++ b/api/src/main/java/edu/cornell/mannlib/vitro/webapp/reasoner/SimpleReasoner.java @@ -82,12 +82,12 @@ public class SimpleReasoner extends StatementListener /** * @param tboxModel - input. This model contains both asserted and inferred TBox axioms - * @param aboxModel - input. This model contains asserted ABox statements + * @param rdfService - input. An RDF Service * @param inferenceModel - output. This is the model in which inferred (materialized) * ABox statements are maintained (added or retracted). * @param inferenceRebuildModel - output. This the model is temporarily used when the * whole ABox inference model is rebuilt - * @param inferenceScratchpadModel - output. This the model is temporarily used when + * @param scratchpadModel - output. This the model is temporarily used when * the whole ABox inference model is rebuilt * @param searchIndexer - output. If not null, the indexer will be paused before the * ABox inference model is rebuilt and unpaused when the rebuild is complete. diff --git a/api/src/main/java/edu/cornell/mannlib/vitro/webapp/reasoner/plugin/SimpleBridgingRule.java b/api/src/main/java/edu/cornell/mannlib/vitro/webapp/reasoner/plugin/SimpleBridgingRule.java index 6ffb1853e..2246f0f5a 100644 --- a/api/src/main/java/edu/cornell/mannlib/vitro/webapp/reasoner/plugin/SimpleBridgingRule.java +++ b/api/src/main/java/edu/cornell/mannlib/vitro/webapp/reasoner/plugin/SimpleBridgingRule.java @@ -26,7 +26,7 @@ import edu.cornell.mannlib.vitro.webapp.reasoner.SimpleReasoner; /** * handles rules of the form - * assertedProp1(?x, ?y) ^ assertedProp2(?y, ?z) -> inferredProp(?x, ?z) + * assertedProp1(?x, ?y) ^ assertedProp2(?y, ?z) -> inferredProp(?x, ?z) * */ public abstract class SimpleBridgingRule implements ReasonerPlugin { diff --git a/api/src/main/java/edu/cornell/mannlib/vitro/webapp/reasoner/plugin/SimplePropertyAndTypeRule.java b/api/src/main/java/edu/cornell/mannlib/vitro/webapp/reasoner/plugin/SimplePropertyAndTypeRule.java index b8431a281..56e1cccf5 100644 --- a/api/src/main/java/edu/cornell/mannlib/vitro/webapp/reasoner/plugin/SimplePropertyAndTypeRule.java +++ b/api/src/main/java/edu/cornell/mannlib/vitro/webapp/reasoner/plugin/SimplePropertyAndTypeRule.java @@ -18,7 +18,7 @@ import edu.cornell.mannlib.vitro.webapp.reasoner.SimpleReasoner; /** * handles rules of the form - * assertedProp(?x, ?y) ^ type(?x) -> inferredProp(?x, ?y) + * assertedProp(?x, ?y) ^ type(?x) -> inferredProp(?x, ?y) * * @author bjl23 * diff --git a/api/src/main/java/edu/cornell/mannlib/vitro/webapp/search/controller/PagedSearchController.java b/api/src/main/java/edu/cornell/mannlib/vitro/webapp/search/controller/PagedSearchController.java index be9d7491d..57fcc63a2 100644 --- a/api/src/main/java/edu/cornell/mannlib/vitro/webapp/search/controller/PagedSearchController.java +++ b/api/src/main/java/edu/cornell/mannlib/vitro/webapp/search/controller/PagedSearchController.java @@ -347,7 +347,6 @@ public class PagedSearchController extends FreemarkerHttpServlet { /** * Get the class groups represented for the individuals in the documents. - * @param qtxt */ private List getClassGroupsLinks(VitroRequest vreq, VClassGroupDao grpDao, SearchResultDocumentList docs, SearchResponse rsp, String qtxt) { Map cgURItoCount = new HashMap(); @@ -604,8 +603,6 @@ public class PagedSearchController extends FreemarkerHttpServlet { /** * Makes a message to display to user for a bad search term. - * @param queryText - * @param exceptionMsg */ private String makeBadSearchMessage(String querytext, String exceptionMsg, VitroRequest vreq){ String rv = ""; diff --git a/api/src/main/java/edu/cornell/mannlib/vitro/webapp/sparql/GetAllPrefix.java b/api/src/main/java/edu/cornell/mannlib/vitro/webapp/sparql/GetAllPrefix.java index 3ddd4930d..12e37bcb1 100644 --- a/api/src/main/java/edu/cornell/mannlib/vitro/webapp/sparql/GetAllPrefix.java +++ b/api/src/main/java/edu/cornell/mannlib/vitro/webapp/sparql/GetAllPrefix.java @@ -85,7 +85,7 @@ public class GetAllPrefix extends BaseEditController { * Returns a map of prefixes for use in building queries. Will manufacture a * prefix for any namespace that doesn't have an associated owl:Ontology resource * with a prefix annotation - * @param wadf + * @param wadf DAO Factory * @return map of prefix strings to namespace URIs */ private Map getPrefixMap(WebappDaoFactory wadf) { @@ -135,8 +135,8 @@ public class GetAllPrefix extends BaseEditController { /** * Makes the markup for a prefix option - * @param prefix - * @param URI + * @param prefix Prefix + * @param URI URI * @return option string */ private String makeOption(String prefix, String URI) { diff --git a/api/src/main/java/edu/cornell/mannlib/vitro/webapp/sparql/GetClazzAllProperties.java b/api/src/main/java/edu/cornell/mannlib/vitro/webapp/sparql/GetClazzAllProperties.java index d0b902f0e..a86842116 100644 --- a/api/src/main/java/edu/cornell/mannlib/vitro/webapp/sparql/GetClazzAllProperties.java +++ b/api/src/main/java/edu/cornell/mannlib/vitro/webapp/sparql/GetClazzAllProperties.java @@ -33,9 +33,6 @@ import edu.cornell.mannlib.vitro.webapp.dao.VClassDao; /** * This servlet gets all the properties for a given subject. - * - * @param vClassURI - * @author yuysun */ public class GetClazzAllProperties extends BaseEditController { diff --git a/api/src/main/java/edu/cornell/mannlib/vitro/webapp/sparql/GetClazzDataProperties.java b/api/src/main/java/edu/cornell/mannlib/vitro/webapp/sparql/GetClazzDataProperties.java index 7917fefff..56f674500 100644 --- a/api/src/main/java/edu/cornell/mannlib/vitro/webapp/sparql/GetClazzDataProperties.java +++ b/api/src/main/java/edu/cornell/mannlib/vitro/webapp/sparql/GetClazzDataProperties.java @@ -22,9 +22,6 @@ import edu.cornell.mannlib.vitro.webapp.dao.DataPropertyDao; /** * This servlet gets all the data properties for a given subject. - * - * @param vClassURI - * @author yuysun */ public class GetClazzDataProperties extends BaseEditController { diff --git a/api/src/main/java/edu/cornell/mannlib/vitro/webapp/sparql/GetClazzObjectProperties.java b/api/src/main/java/edu/cornell/mannlib/vitro/webapp/sparql/GetClazzObjectProperties.java index 4d697ab24..5b58f6daa 100644 --- a/api/src/main/java/edu/cornell/mannlib/vitro/webapp/sparql/GetClazzObjectProperties.java +++ b/api/src/main/java/edu/cornell/mannlib/vitro/webapp/sparql/GetClazzObjectProperties.java @@ -30,9 +30,6 @@ import edu.cornell.mannlib.vitro.webapp.dao.VClassDao; /** * This servlet gets all the object properties for a given subject. - * - * @param vClassURI - * @author yuysun */ public class GetClazzObjectProperties extends BaseEditController { diff --git a/api/src/main/java/edu/cornell/mannlib/vitro/webapp/sparql/GetObjectClasses.java b/api/src/main/java/edu/cornell/mannlib/vitro/webapp/sparql/GetObjectClasses.java index 21585b65e..be744e814 100644 --- a/api/src/main/java/edu/cornell/mannlib/vitro/webapp/sparql/GetObjectClasses.java +++ b/api/src/main/java/edu/cornell/mannlib/vitro/webapp/sparql/GetObjectClasses.java @@ -24,9 +24,6 @@ import edu.cornell.mannlib.vitro.webapp.dao.VClassDao; /** * This servlet gets all the range classes for a given predicate. - * - * @param predicate - * @author yuysun */ public class GetObjectClasses extends BaseEditController { diff --git a/api/src/main/java/edu/cornell/mannlib/vitro/webapp/utils/JsonToFmModel.java b/api/src/main/java/edu/cornell/mannlib/vitro/webapp/utils/JsonToFmModel.java index 054ad865f..d7da6488a 100644 --- a/api/src/main/java/edu/cornell/mannlib/vitro/webapp/utils/JsonToFmModel.java +++ b/api/src/main/java/edu/cornell/mannlib/vitro/webapp/utils/JsonToFmModel.java @@ -52,7 +52,7 @@ public final class JsonToFmModel /** * Convert JSON Object string to Freemarker-compatible data model * - * @param jsonString + * @param jsonString JSON string * @return model * @throws JSONException */ @@ -63,7 +63,7 @@ public final class JsonToFmModel } /** - * JSONObject is an unordered collection of name/value pairs -> convert to Map (equivalent to Freemarker "hash") + * JSONObject is an unordered collection of name/value pairs -> convert to Map (equivalent to Freemarker "hash") */ @SuppressWarnings("unchecked") public static Map convertJSONObjectToMap(JSONObject jo) throws JSONException @@ -105,7 +105,7 @@ public final class JsonToFmModel /** * Convert JSON Array string to Freemarker-compatible data model * - * @param jsonString + * @param jsonString JSON String * @return model * @throws JSONException */ @@ -118,7 +118,7 @@ public final class JsonToFmModel } /** - * JSONArray is an ordered sequence of values -> convert to List (equivalent to Freemarker "sequence") + * JSONArray is an ordered sequence of values -> convert to List (equivalent to Freemarker "sequence") */ public static List convertJSONArrayToList(JSONArray ja) throws JSONException { diff --git a/api/src/main/java/edu/cornell/mannlib/vitro/webapp/utils/MakeTidy.java b/api/src/main/java/edu/cornell/mannlib/vitro/webapp/utils/MakeTidy.java index 3b538df7f..ecf7ee178 100644 --- a/api/src/main/java/edu/cornell/mannlib/vitro/webapp/utils/MakeTidy.java +++ b/api/src/main/java/edu/cornell/mannlib/vitro/webapp/utils/MakeTidy.java @@ -81,7 +81,7 @@ public class MakeTidy { } /** - * We don't want to log a partial line, so {@link #flush()} does + * We don't want to log a partial line, so does * nothing. */ @Override diff --git a/api/src/main/java/edu/cornell/mannlib/vitro/webapp/utils/NamespaceMapper.java b/api/src/main/java/edu/cornell/mannlib/vitro/webapp/utils/NamespaceMapper.java index 16cbf8477..1ca5f58dc 100644 --- a/api/src/main/java/edu/cornell/mannlib/vitro/webapp/utils/NamespaceMapper.java +++ b/api/src/main/java/edu/cornell/mannlib/vitro/webapp/utils/NamespaceMapper.java @@ -11,24 +11,21 @@ public interface NamespaceMapper extends ModelChangedListener { /** * Returns the current abbreviation to use for a given namespace, * or null if undefined. - * @param namespace - * @return + * @param namespace Namespace */ public String getPrefixForNamespace(String namespace); /** * Returns a list of abbreviations that have been used to * represent a given namespace. - * @param namespace - * @return + * @param namespace Namespace */ public List getPrefixesForNamespace(String namespace); /** * Returns the full namespace URI represented by a given * abbreviation, or null if not found. - * @param namespace - * @return + * @param prefix Prefix */ public String getNamespaceForPrefix(String prefix); diff --git a/api/src/main/java/edu/cornell/mannlib/vitro/webapp/utils/SparqlQueryUtils.java b/api/src/main/java/edu/cornell/mannlib/vitro/webapp/utils/SparqlQueryUtils.java index 2a1b70543..fcbe1cea1 100644 --- a/api/src/main/java/edu/cornell/mannlib/vitro/webapp/utils/SparqlQueryUtils.java +++ b/api/src/main/java/edu/cornell/mannlib/vitro/webapp/utils/SparqlQueryUtils.java @@ -58,7 +58,7 @@ public class SparqlQueryUtils { /** * A convenience method to attempt parsing a query string with various syntaxes - * @param queryString + * @param queryString Query String * @return Query */ public static Query create(String queryString) { diff --git a/api/src/main/java/edu/cornell/mannlib/vitro/webapp/utils/dataGetter/BrowseDataGetter.java b/api/src/main/java/edu/cornell/mannlib/vitro/webapp/utils/dataGetter/BrowseDataGetter.java index e1c9542f8..83c2d518e 100644 --- a/api/src/main/java/edu/cornell/mannlib/vitro/webapp/utils/dataGetter/BrowseDataGetter.java +++ b/api/src/main/java/edu/cornell/mannlib/vitro/webapp/utils/dataGetter/BrowseDataGetter.java @@ -143,7 +143,9 @@ public class BrowseDataGetter extends DataGetterBase implements DataGetter { /** * Gets a list of all VClassGroups with vclasses with individual counts. - * @param params2 + * @param request current VitroRequest + * @param params a parameter map + * @param context current servlet context */ protected Map getAllClassGroupData(VitroRequest request, Map params, ServletContext context){ Map map = new HashMap(); diff --git a/api/src/main/java/edu/cornell/mannlib/vitro/webapp/utils/dataGetter/DataGetterUtils.java b/api/src/main/java/edu/cornell/mannlib/vitro/webapp/utils/dataGetter/DataGetterUtils.java index 80324934a..ad37993a9 100644 --- a/api/src/main/java/edu/cornell/mannlib/vitro/webapp/utils/dataGetter/DataGetterUtils.java +++ b/api/src/main/java/edu/cornell/mannlib/vitro/webapp/utils/dataGetter/DataGetterUtils.java @@ -352,9 +352,6 @@ public class DataGetterUtils { /*** * For the page, get the actual Data Getters to be employed. - * @throws ClassNotFoundException - * @throws IllegalAccessException - * @throws InstantiationException */ /* public static List DataGetterObjects(VitroRequest vreq, String pageUri) throws InstantiationException, IllegalAccessException, ClassNotFoundException { diff --git a/api/src/main/java/edu/cornell/mannlib/vitro/webapp/utils/jena/DedupAndExtract.java b/api/src/main/java/edu/cornell/mannlib/vitro/webapp/utils/jena/DedupAndExtract.java index cbfeb6ada..1fdd84523 100644 --- a/api/src/main/java/edu/cornell/mannlib/vitro/webapp/utils/jena/DedupAndExtract.java +++ b/api/src/main/java/edu/cornell/mannlib/vitro/webapp/utils/jena/DedupAndExtract.java @@ -19,9 +19,8 @@ public class DedupAndExtract { /** * Returns a model where redundant individuals that are sameAs one another are smushed * using URIs in preferred namespaces where possible. - * @param model - * @param preferredIndividualNamespace - * @return + * @param model Jena Model + * @param preferredNamespace Preferred namespace */ public Model dedupAndExtract( Model model, String preferredNamespace ) { diff --git a/api/src/main/java/edu/cornell/mannlib/vitro/webapp/utils/jena/JenaIngestUtils.java b/api/src/main/java/edu/cornell/mannlib/vitro/webapp/utils/jena/JenaIngestUtils.java index c3d5b4a39..b40f3b7f7 100644 --- a/api/src/main/java/edu/cornell/mannlib/vitro/webapp/utils/jena/JenaIngestUtils.java +++ b/api/src/main/java/edu/cornell/mannlib/vitro/webapp/utils/jena/JenaIngestUtils.java @@ -50,9 +50,9 @@ public class JenaIngestUtils { private Random random = new Random(System.currentTimeMillis()); /** - * Returns a new copy of the input model with blank nodes renamed with namespaceEtc plus a random int. - * @param namespaceEtc - * @return + * Returns a new copy of the input model with blank nodes renamed with namespaceEtc plus a random int. + * @param inModel input Jena Model + * @param namespaceEtc Namespace */ public Model renameBNodes(Model inModel, String namespaceEtc) { return renameBNodes(inModel, namespaceEtc, null); @@ -61,8 +61,8 @@ public class JenaIngestUtils { /** * Returns a new copy of the input model with blank nodes renamed with namespaceEtc plus a random int. * Will prevent URI collisions with supplied dedupModel - * @param namespaceEtc - * @return + * @param inModel input Jena Model + * @param namespaceEtc Namespace */ public Model renameBNodes(Model inModel, String namespaceEtc, Model dedupModel) { Model outModel = ModelFactory.createDefaultModel(); @@ -361,11 +361,11 @@ public class JenaIngestUtils { * Splits values for a given data property URI on a supplied regex and * asserts each value using newPropertyURI. New statements returned in * a Jena Model. Split values may be optionally trim()ed. - * @param inModel - * @param propertyURI - * @param splitRegex - * @param newPropertyURI - * @param trim + * @param inModel Input Jena model + * @param propertyURI URI for property + * @param splitRegex Regex for split + * @param newPropertyURI URI for new property + * @param trim Flag to trim property * @return outModel */ public Model splitPropertyValues(Model inModel, String propertyURI, String splitRegex, String newPropertyURI, boolean trim) { @@ -418,9 +418,8 @@ public class JenaIngestUtils { /** * A simple resource smusher based on a supplied inverse-functional property. * A new model containing only resources about the smushed statements is returned. - * @param inModel - * @param prop - * @return + * @param inModel Input Jena model + * @param prop Property */ public Model smushResources(Model inModel, Property prop) { Model outModel = ModelFactory.createDefaultModel(); @@ -480,9 +479,8 @@ public class JenaIngestUtils { /** * Returns a model where redundant individuals that are sameAs one another are smushed * using URIs in preferred namespaces where possible. - * @param model - * @param preferredIndividualNamespace - * @return + * @param model Jena Model + * @param preferredNamespace Preferred Namespace */ public Model dedupAndExtract( Model model, String preferredNamespace ) { Model extractsModel = ModelFactory.createDefaultModel(); @@ -622,7 +620,6 @@ public class JenaIngestUtils { * @param baseOntModel The model containing the relevant statements * @param tboxOntModel The model containing class and property data * @param usePrimaryLabelOnly If true, discard rdfs:labels from uri2. Otherwise retain. - * @return */ public MergeResult doMerge(String uri1, String uri2, OntModel baseOntModel, OntModel tboxOntModel, boolean usePrimaryLabelOnly){ diff --git a/api/src/main/java/edu/cornell/mannlib/vitro/webapp/utils/logging/StackTraceLayout.java b/api/src/main/java/edu/cornell/mannlib/vitro/webapp/utils/logging/StackTraceLayout.java index 383d509d8..0a3915842 100644 --- a/api/src/main/java/edu/cornell/mannlib/vitro/webapp/utils/logging/StackTraceLayout.java +++ b/api/src/main/java/edu/cornell/mannlib/vitro/webapp/utils/logging/StackTraceLayout.java @@ -48,7 +48,7 @@ public class StackTraceLayout extends Layout { /** * The StackTraceLayout does not handle the throwable contained within - * LoggingEvents. Thus, it returns true. + * LoggingEvents. Thus, it returns {@code true}. */ @Override public boolean ignoresThrowable() { diff --git a/api/src/main/java/edu/cornell/mannlib/vitro/webapp/utils/sparql/SelectQueryRunner.java b/api/src/main/java/edu/cornell/mannlib/vitro/webapp/utils/sparql/SelectQueryRunner.java index cbf81068a..ad640cc5d 100644 --- a/api/src/main/java/edu/cornell/mannlib/vitro/webapp/utils/sparql/SelectQueryRunner.java +++ b/api/src/main/java/edu/cornell/mannlib/vitro/webapp/utils/sparql/SelectQueryRunner.java @@ -16,7 +16,7 @@ import edu.cornell.mannlib.vitro.webapp.rdfservice.RDFService; /** * A conversational tool for handling SPARQL queries. * - * 
+ * {@code
  * Examples:
  *   List values = createQueryContext(rdfService, queryString)
  *                             .bindVariableToUri("uri", uri)
@@ -29,7 +29,7 @@ import edu.cornell.mannlib.vitro.webapp.rdfservice.RDFService;
  *   List map = createQueryContext(rdfService, q)
  *                             .execute()
  *                             .getStringFields();
- *
+ * } * * The execute() method does not actually execute the query: it merely sets it * up syntactically. diff --git a/api/src/main/java/edu/cornell/mannlib/vitro/webapp/web/ContentType.java b/api/src/main/java/edu/cornell/mannlib/vitro/webapp/web/ContentType.java index 42f25f521..a46b6c38c 100644 --- a/api/src/main/java/edu/cornell/mannlib/vitro/webapp/web/ContentType.java +++ b/api/src/main/java/edu/cornell/mannlib/vitro/webapp/web/ContentType.java @@ -245,13 +245,13 @@ public class ContentType implements Serializable { * based on the "Accept" header from a servlet request. * * @param acceptHeader "Accept" header value from a servlet request (not - * null) + * {@code null}) * @param actualContentTypes actual content types in descending order of * preference (non-empty, and each entry is of the * form "type/subtype" without the wildcard char - * '*') or null if no "Accept" header + * '*') or {@code null} if no "Accept" header * was specified - * @return the best content type to use (or null on no match). + * @return the best content type to use (or {@code null} on no match). */ public static ContentType getBestContentType(String acceptHeader, List actualContentTypes) { @@ -332,7 +332,7 @@ public class ContentType implements Serializable { * * From suggestions by Tim Berners-Lee at http://www.w3.org/DesignIssues/Conneg * - * @param clentAcceptsTypes types the client can accept with Q weights. + * @param clientAcceptsTypes types the client can accept with Q weights. * @param serverTypes types the server can provide with Q weights. * @return returns content type of best match or null if no match. */ @@ -355,7 +355,7 @@ public class ContentType implements Serializable { /** * This method was added by Brian Caruso of the VIVO project. March 15 2011. * - * @param acceptHeader + * @param acceptHeader Accept header * @return the types and the q values from the accept header */ public static Map getTypesAndQ(String acceptHeader){ @@ -514,7 +514,7 @@ public class ContentType implements Serializable { /** * Makes the object immutable and returns it. * - * This should at least be used when keeping a {@link ContentType} instance as + * This should at least be used when keeping an instance as * a static. */ public ContentType lock() { diff --git a/api/src/main/java/edu/cornell/mannlib/vitro/webapp/web/MiscWebUtils.java b/api/src/main/java/edu/cornell/mannlib/vitro/webapp/web/MiscWebUtils.java index 7db3834d8..51147adaf 100755 --- a/api/src/main/java/edu/cornell/mannlib/vitro/webapp/web/MiscWebUtils.java +++ b/api/src/main/java/edu/cornell/mannlib/vitro/webapp/web/MiscWebUtils.java @@ -65,8 +65,8 @@ public class MiscWebUtils { * Gets an attribute from the request, if it is not null, and of Class String * print it to req.out, otherwise throw an exception. * - * @param req - * @param attribute + * @param request Servlet Request + * @param attribute Attribute name */ public static String writeAttribute(HttpServletRequest request, String attribute) throws JspException{ @@ -140,8 +140,7 @@ public class MiscWebUtils { /** * returns a table of the req attributes - * @param req - * @return + * @param req Servlet Request */ public static String getRequestAttributes( HttpServletRequest req){ String val = ""; @@ -260,9 +259,8 @@ public class MiscWebUtils { /** This isfrom org.json.simple.JSONObject - * " => \" , \ => \\ - * @param s - * @return + * {@code " => \" , \ => \\ } + * @param s String to escape */ public static String escape(String s){ if(s==null) diff --git a/api/src/main/java/edu/cornell/mannlib/vitro/webapp/web/templatemodels/Tags.java b/api/src/main/java/edu/cornell/mannlib/vitro/webapp/web/templatemodels/Tags.java index 01748727b..ce1522f78 100644 --- a/api/src/main/java/edu/cornell/mannlib/vitro/webapp/web/templatemodels/Tags.java +++ b/api/src/main/java/edu/cornell/mannlib/vitro/webapp/web/templatemodels/Tags.java @@ -40,8 +40,6 @@ public class Tags extends BaseTemplateModel { * that exposes certain write methods, instead of the configuration's object wrapper, * which doesn't. The templates can then add stylesheets and scripts to the lists * by calling their add() methods. - * @param Tags tags - * @return TemplateModel */ static public class TagsWrapper extends BeansWrapper { diff --git a/api/src/main/java/edu/cornell/mannlib/vitro/webapp/web/templatemodels/individual/ObjectPropertyTemplateModel.java b/api/src/main/java/edu/cornell/mannlib/vitro/webapp/web/templatemodels/individual/ObjectPropertyTemplateModel.java index bdba06ffe..e26c43545 100644 --- a/api/src/main/java/edu/cornell/mannlib/vitro/webapp/web/templatemodels/individual/ObjectPropertyTemplateModel.java +++ b/api/src/main/java/edu/cornell/mannlib/vitro/webapp/web/templatemodels/individual/ObjectPropertyTemplateModel.java @@ -294,7 +294,7 @@ public abstract class ObjectPropertyTemplateModel extends PropertyTemplateModel /** The SPARQL query results may contain duplicate rows for a single object, if there are multiple solutions * to the entire query. Remove duplicates here by arbitrarily selecting only the first row returned. - * @param List> data + * @param data The data to deduplicate */ protected void removeDuplicates(List> data) { String objectVariableName = getObjectKey(); diff --git a/api/src/main/java/edu/cornell/mannlib/vitro/webapp/web/widgets/DateTimeWidget.java b/api/src/main/java/edu/cornell/mannlib/vitro/webapp/web/widgets/DateTimeWidget.java index ba0fb419c..dcebf656d 100644 --- a/api/src/main/java/edu/cornell/mannlib/vitro/webapp/web/widgets/DateTimeWidget.java +++ b/api/src/main/java/edu/cornell/mannlib/vitro/webapp/web/widgets/DateTimeWidget.java @@ -15,6 +15,7 @@ import freemarker.core.Environment; * * It is intended to be used like this: * + * {@code * <@widget name="DateTime" dateTime="2010-11-23T11:03:23" > * The year is ${year} * The month is ${month} @@ -23,6 +24,7 @@ import freemarker.core.Environment; * The second is ${second} * precision of date entered: ${precisionUri} * + * } * * @author bdc34 * diff --git a/api/src/main/java/org/json/Cookie.java b/api/src/main/java/org/json/Cookie.java index bb05ebc15..b752461fd 100644 --- a/api/src/main/java/org/json/Cookie.java +++ b/api/src/main/java/org/json/Cookie.java @@ -140,11 +140,11 @@ public class Cookie { } /** - * Convert %hh sequences to single characters, and + * Convert {@code %}hh sequences to single characters, and * convert plus to space. * @param s A string that may contain - * + (plus) and - * %hh sequences. + * {@code +} (plus) and + * {@code %}hh sequences. * @return The unescaped string. */ public static String unescape(String s) { diff --git a/api/src/main/java/org/json/HTTP.java b/api/src/main/java/org/json/HTTP.java index d3b62f835..131676267 100644 --- a/api/src/main/java/org/json/HTTP.java +++ b/api/src/main/java/org/json/HTTP.java @@ -39,28 +39,28 @@ public class HTTP { /** * Convert an HTTP header string into a JSONObject. It can be a request * header or a response header. A request header will contain - * 
{
+     * {@code {
      *    Method: "POST" (for example),
      *    "Request-URI": "/" (for example),
      *    "HTTP-Version": "HTTP/1.1" (for example)
-     * }
+ * }} * A response header will contain - * 
{
+     * {@code {
      *    "HTTP-Version": "HTTP/1.1" (for example),
      *    "Status-Code": "200" (for example),
      *    "Reason-Phrase": "OK" (for example)
-     * }
+ * }} * In addition, the other parameters in the header will be captured, using - * the HTTP field names as JSON names, so that 
+     * the HTTP field names as JSON names, so that {@code
      *    Date: Sun, 26 May 2002 18:06:04 GMT
      *    Cookie: Q=q2=PPEAsg--; B=677gi6ouf29bn&b=2&f=s
-     *    Cache-Control: no-cache
+ * Cache-Control: no-cache} * become - * 
{...
+     * {@code {...
      *    Date: "Sun, 26 May 2002 18:06:04 GMT",
      *    Cookie: "Q=q2=PPEAsg--; B=677gi6ouf29bn&b=2&f=s",
      *    "Cache-Control": "no-cache",
-     * ...}
+ * ...}} * It does no further checking or conversion. It does not parse dates. * It does not do '%' transforms on URLs. * @param string An HTTP header string. diff --git a/api/src/main/java/org/json/JSONArray.java b/api/src/main/java/org/json/JSONArray.java index 7254a0c35..b5b59eac5 100644 --- a/api/src/main/java/org/json/JSONArray.java +++ b/api/src/main/java/org/json/JSONArray.java @@ -33,46 +33,46 @@ import java.util.Map; /** * A JSONArray is an ordered sequence of values. Its external text form is a * string wrapped in square brackets with commas separating the values. The - * internal form is an object having get and opt - * methods for accessing the values by index, and put methods for + * internal form is an object having {@code get} and {@code opt} + * methods for accessing the values by index, and {@code put} methods for * adding or replacing values. The values can be any of these types: - * Boolean, JSONArray, JSONObject, - * Number, String, or the - * JSONObject.NULL object. + * {@code Boolean}, {@code JSONArray}, {@code JSONObject}, + * {@code Number}, {@code String}, or the + * {@code JSONObject.NULL object}. *

* The constructor can convert a JSON text into a Java object. The - * toString method converts to JSON text. + * {@code toString} method converts to JSON text. *

- * A get method returns a value if one can be found, and throws an - * exception if one cannot be found. An opt method returns a + * A {@code get} method returns a value if one can be found, and throws an + * exception if one cannot be found. An {@code opt} method returns a * default value instead of throwing an exception, and so is useful for * obtaining optional values. *

- * The generic get() and opt() methods return an + * The generic {@code get()} and {@code opt()} methods return an * object which you can cast or query for type. There are also typed - * get and opt methods that do type checking and type + * {@code get} and {@code opt} methods that do type checking and type * coersion for you. *

- * The texts produced by the toString methods strictly conform to + * The texts produced by the {@code toString} methods strictly conform to * JSON syntax rules. The constructors are more forgiving in the texts they will * accept: *

    - *
  • An extra , (comma) may appear just + *
  • An extra {@code ,} (comma) may appear just * before the closing bracket.
    • - *
  • The null value will be inserted when there - * is , (comma) elision.
    • - *
  • Strings may be quoted with ' (single + *
  • The {@code null} value will be inserted when there + * is {@code ,} (comma) elision.
    • + *
  • Strings may be quoted with {@code '} (single * quote).
    • *
  • Strings do not need to be quoted at all if they do not begin with a quote * or single quote, and if they do not contain leading or trailing spaces, * and if they do not contain any of these characters: - * { } [ ] / \ : , = ; # and if they do not look like numbers - * and if they are not the reserved words true, - * false, or null.
    • - *
  • Values can be separated by ; (semicolon) as - * well as by , (comma).
    • - *
  • Numbers may have the 0- (octal) or - * 0x- (hex) prefix.
    • + * {@code { } [ ] / \ : , = ; #} and if they do not look like numbers + * and if they are not the reserved words {@code true}, + * {@code false}, or {@code null}. + *
  • Values can be separated by {@code ;} (semicolon) as + * well as by {@code ,} (comma).
    • + *
  • Numbers may have the {@code 0-} (octal) or + * {@code 0x-} (hex) prefix.
    • *
  • Comments written in the slashshlash, slashstar, and hash conventions * will be ignored.
    • *
@@ -138,8 +138,8 @@ public class JSONArray { /** * Construct a JSONArray from a source sJSON text. * @param string A string that begins with - * [ (left bracket) - * and ends with ] (right bracket). + * {@code [} (left bracket) + * and ends with {@code ]} (right bracket). * @throws JSONException If there is a syntax error. */ public JSONArray(String string) throws JSONException { @@ -307,7 +307,7 @@ public class JSONArray { /** * Make a string from the contents of this JSONArray. The - * separator string is inserted between each element. + * {@code separator} string is inserted between each element. * Warning: This method assumes that the data structure is acyclical. * @param separator A string that will be inserted between the elements. * @return a string. @@ -780,8 +780,8 @@ public class JSONArray { * indentation. * @return a printable, displayable, transmittable * representation of the object, beginning - * with [ (left bracket) and ending - * with ] (right bracket). + * with {@code [} (left bracket) and ending + * with {@code ]} (right bracket). * @throws JSONException */ public String toString(int indentFactor) throws JSONException { diff --git a/api/src/main/java/org/json/JSONObject.java b/api/src/main/java/org/json/JSONObject.java index b0e011120..89686da77 100644 --- a/api/src/main/java/org/json/JSONObject.java +++ b/api/src/main/java/org/json/JSONObject.java @@ -36,49 +36,49 @@ import java.io.Writer; * A JSONObject is an unordered collection of name/value pairs. Its * external form is a string wrapped in curly braces with colons between the * names and values, and commas between the values and names. The internal form - * is an object having get and opt methods for - * accessing the values by name, and put methods for adding or + * is an object having {@code get} and {@code opt} methods for + * accessing the values by name, and {@code put} methods for adding or * replacing values by name. The values can be any of these types: - * Boolean, JSONArray, JSONObject, - * Number, String, or the JSONObject.NULL + * {@code Boolean}, {@code JSONArray}, {@code JSONObject}, + * {@code Number}, {@code String}, or the {@code JSONObject.NULL} * object. A JSONObject constructor can be used to convert an external form * JSON text into an internal form whose values can be retrieved with the - * get and opt methods, or to convert values into a - * JSON text using the put and toString methods. - * A get method returns a value if one can be found, and throws an - * exception if one cannot be found. An opt method returns a + * {@code get} and {@code opt} methods, or to convert values into a + * JSON text using the {@code put} and {@code toString} methods. + * A {@code get} method returns a value if one can be found, and throws an + * exception if one cannot be found. An {@code opt} method returns a * default value instead of throwing an exception, and so is useful for * obtaining optional values. *

- * The generic get() and opt() methods return an + * The generic {@code get()} and {@code opt()} methods return an * object, which you can cast or query for type. There are also typed - * get and opt methods that do type checking and type + * {@code get} and {@code opt} methods that do type checking and type * coersion for you. *

- * The put methods adds values to an object. For example, 

+ * The {@code put} methods adds values to an object. For example, 
  *     myString = new JSONObject().put("JSON", "Hello, World!").toString();

- * produces the string {"JSON": "Hello, World"}.
+ * produces the string {@code {"JSON": "Hello, World"}}.
  * 

- * The texts produced by the toString methods strictly conform to
+ * The texts produced by the {@code toString} methods strictly conform to
  * the JSON sysntax rules.
  * The constructors are more forgiving in the texts they will accept:
  * 
    
- * 
  • An extra , (comma) may appear just
+ * 
  • An extra {@code ,} (comma) may appear just
  *     before the closing brace.
    • 
- * 
  • Strings may be quoted with ' (single
+ * 
  • Strings may be quoted with {@code '} (single
  *     quote).
    • 
  * 
  • Strings do not need to be quoted at all if they do not begin with a quote
  *     or single quote, and if they do not contain leading or trailing spaces,
  *     and if they do not contain any of these characters:
- *     { } [ ] / \ : , = ; # and if they do not look like numbers
- *     and if they are not the reserved words true,
- *     false, or null.
    • 
- * 
  • Keys can be followed by = or => as well as
- *     by :.
    • 
- * 
  • Values can be followed by ; (semicolon) as
- *     well as by , (comma).
    • 
- * 
  • Numbers may have the 0- (octal) or
- *     0x- (hex) prefix.
    • 
+ *     {@code { } [ ] / \ : , = ; #} and if they do not look like numbers
+ *     and if they are not the reserved words {@code true},
+ *     {@code false}, or {@code null}.
+ * 
  • Keys can be followed by {@code =} or {@code =>} as well as
+ *     by {@code :}.
    • 
+ * 
  • Values can be followed by {@code ;} (semicolon) as
+ *     well as by {@code ,} (comma).
    • 
+ * 
  • Numbers may have the {@code 0-} (octal) or
+ *     {@code 0x-} (hex) prefix.
    • 
  * 
  • Comments written in the slashshlash, slashstar, and hash conventions
  *     will be ignored.
    • 
  * 

@@ -133,9 +133,9 @@ public class JSONObject {
 
     /**
      * It is sometimes more convenient and less ambiguous to have a
-     * NULL object than to use Java's null value.
-     * JSONObject.NULL.equals(null) returns true.
-     * JSONObject.NULL.toString() returns "null".
+     * {@code NULL} object than to use Java's {@code null} value.
+     * {@code JSONObject.NULL.equals(null)} returns {@code true}.
+     * {@code JSONObject.NULL.toString()} returns {@code "null"}.
      */
     public static final Object NULL = new Null();
 
@@ -267,8 +267,8 @@ public class JSONObject {
      * Construct a JSONObject from a string.
      * This is the most commonly used JSONObject constructor.
      * @param string    A string beginning
-     *  with { (left brace) and ending
-     *  with } (right brace).
+     *  with {@code {} (left brace) and ending
+     *  with {@code }} (right brace).
      * @exception JSONException If there is a syntax error in the source string.
      */
     public JSONObject(String string) throws JSONException {
@@ -908,7 +908,7 @@ public class JSONObject {
 
     /**
      * Produce a string in double quotes with backslash sequences in all the
-     * right places. A backslash will be inserted within { (left brace) and ending
-     *  with } (right brace).
+     *  with {@code {} (left brace) and ending
+     *  with {@code }} (right brace).
      */
     public String toString() {
         try {
@@ -1064,8 +1064,8 @@ public class JSONObject {
      *  indentation.
      * @return a printable, displayable, portable, transmittable
      *  representation of the object, beginning
-     *  with { (left brace) and ending
-     *  with } (right brace).
+     *  with {@code {} (left brace) and ending
+     *  with {@code }} (right brace).
      * @throws JSONException If the object contains an invalid number.
      */
     public String toString(int indentFactor) throws JSONException {
@@ -1082,8 +1082,8 @@ public class JSONObject {
      * @param indent The indentation of the top level.
      * @return a printable, displayable, transmittable
      *  representation of the object, beginning
-     *  with { (left brace) and ending
-     *  with } (right brace).
+     *  with {@code {} (left brace) and ending
+     *  with {@code }} (right brace).
      * @throws JSONException If the object contains an invalid number.
      */
     String toString(int indentFactor, int indent) throws JSONException {
@@ -1142,8 +1142,8 @@ public class JSONObject {
      * @param value The value to be serialized.
      * @return a printable, displayable, transmittable
      *  representation of the object, beginning
-     *  with { (left brace) and ending
-     *  with } (right brace).
+     *  with {@code {} (left brace) and ending
+     *  with {@code }} (right brace).
      * @throws JSONException If the value is or contains an invalid number.
      */
     static String valueToString(Object value) throws JSONException {
@@ -1183,8 +1183,8 @@ public class JSONObject {
      * @param indent The indentation of the top level.
      * @return a printable, displayable, transmittable
      *  representation of the object, beginning
-     *  with { (left brace) and ending
-     *  with } (right brace).
+     *  with {@code {} (left brace) and ending
+     *  with {@code }} (right brace).
      * @throws JSONException If the object contains an invalid number.
      */
      static String valueToString(Object value, int indentFactor, int indent)
diff --git a/api/src/main/java/org/json/JSONString.java b/api/src/main/java/org/json/JSONString.java
index 7f4f65b67..2822961ae 100644
--- a/api/src/main/java/org/json/JSONString.java
+++ b/api/src/main/java/org/json/JSONString.java
@@ -1,15 +1,15 @@
 package org.json;
 /**
- * The JSONString interface allows a toJSONString() 
+ * The {@code JSONString} interface allows a {@code toJSONString()}
  * method so that a class can change the behavior of 
- * JSONObject.toString(), JSONArray.toString(),
- * and JSONWriter.value(Object). The 
- * toJSONString method will be used instead of the default behavior 
- * of using the Object's toString() method and quoting the result.
+ * {@code JSONObject.toString()}, {@code JSONArray.toString()},
+ * and {@code JSONWriter.value(}Object{@code )}. The
+ * {@code toJSONString} method will be used instead of the default behavior
+ * of using the Object's {@code toString()} method and quoting the result.
  */
 public interface JSONString {
 	/**
-	 * The toJSONString method allows a class to produce its own JSON 
+	 * The {@code toJSONString} method allows a class to produce its own JSON
 	 * serialization. 
 	 * 
 	 * @return A strictly syntactically correct JSON text.
diff --git a/api/src/main/java/org/json/JSONStringer.java b/api/src/main/java/org/json/JSONStringer.java
index b68efa41a..dcdab0fdf 100644
--- a/api/src/main/java/org/json/JSONStringer.java
+++ b/api/src/main/java/org/json/JSONStringer.java
@@ -32,12 +32,12 @@ import java.io.StringWriter;
  * added, so the results are ready for transmission or storage. Each instance of
  * JSONStringer can produce one JSON text.
  * 

- * A JSONStringer instance provides a value method for appending
+ * A JSONStringer instance provides a {@code value} method for appending
  * values to the
- * text, and a key
- * method for adding keys before values in objects. There are array
- * and endArray methods that make and bound array values, and
- * object and endObject methods which make and bound
+ * text, and a {@code key}
+ * method for adding keys before values in objects. There are {@code array}
+ * and {@code endArray} methods that make and bound array values, and
+ * {@code object} and {@code endObject} methods which make and bound
  * object values. All of these methods return the JSONWriter instance,
  * permitting cascade style. For example, 
  * myString = new JSONStringer()
@@ -48,7 +48,7 @@ import java.io.StringWriter;
  *     .toString();
 which produces the string 
  * {"JSON":"Hello, World!"}

  * 

- * The first method called must be array or object.
+ * The first method called must be {@code array} or {@code object}.
  * There are no methods for adding commas or colons. JSONStringer adds them for
  * you. Objects and arrays can be nested up to 20 levels deep.
  * 

@@ -66,10 +66,10 @@ public class JSONStringer extends JSONWriter {
 
     /**
      * Return the JSON text. This method is used to obtain the product of the
-     * JSONStringer instance. It will return null if there was a
+     * JSONStringer instance. It will return {@code null} if there was a
      * problem in the construction of the JSON text (such as the calls to
-     * array were not properly balanced with calls to
-     * endArray).
+     * {@code array} were not properly balanced with calls to
+     * {@code endArray}).
      * @return The JSON text.
      */
     public String toString() {
diff --git a/api/src/main/java/org/json/JSONTokener.java b/api/src/main/java/org/json/JSONTokener.java
index 1c9b2f937..66a0af34d 100644
--- a/api/src/main/java/org/json/JSONTokener.java
+++ b/api/src/main/java/org/json/JSONTokener.java
@@ -202,8 +202,8 @@ public class JSONTokener {
      * allow strings in single quotes, but an implementation is allowed to
      * accept them.
      * @param quote The quoting character, either
-     *      " (double quote) or
-     *      ' (single quote).
+     *      {@code "} (double quote) or
+     *      {@code '} (single quote).
      * @return      A String.
      * @throws JSONException Unterminated string.
      */
diff --git a/api/src/main/java/org/json/JSONWriter.java b/api/src/main/java/org/json/JSONWriter.java
index e1cd2e9be..b95959ec1 100644
--- a/api/src/main/java/org/json/JSONWriter.java
+++ b/api/src/main/java/org/json/JSONWriter.java
@@ -33,12 +33,12 @@ SOFTWARE.
  * added, so the results are ready for transmission or storage. Each instance of
  * JSONWriter can produce one JSON text.
  * 

- * A JSONWriter instance provides a value method for appending
+ * A JSONWriter instance provides a {@code value} method for appending
  * values to the
- * text, and a key
- * method for adding keys before values in objects. There are array
- * and endArray methods that make and bound array values, and
- * object and endObject methods which make and bound
+ * text, and a {@code key}
+ * method for adding keys before values in objects. There are {@code array}
+ * and {@code endArray} methods that make and bound array values, and
+ * {@code object} and {@code endObject} methods which make and bound
  * object values. All of these methods return the JSONWriter instance,
  * permitting a cascade style. For example, 
  * new JSONWriter(myWriter)
@@ -48,7 +48,7 @@ SOFTWARE.
  *     .endObject();
 which writes 
  * {"JSON":"Hello, World!"}

  * 

- * The first method called must be array or object.
+ * The first method called must be {@code array} or {@code object}.
  * There are no methods for adding commas or colons. JSONWriter adds them for
  * you. Objects and arrays can be nested up to 20 levels deep.
  * 

@@ -131,8 +131,8 @@ public class JSONWriter {
 
     /**
      * Begin appending a new array. All values until the balancing
-     * endArray will be appended to this array. The
-     * endArray method must be called to mark the array's end.
+     * {@code endArray} will be appended to this array. The
+     * {@code endArray} method must be called to mark the array's end.
      * @return this
      * @throws JSONException If the nesting is too deep, or if the object is
      * started in the wrong place (for example as a key or after the end of the
@@ -172,7 +172,7 @@ public class JSONWriter {
 
     /**
      * End an array. This method most be called to balance calls to
-     * array.
+     * {@code array}.
      * @return this
      * @throws JSONException If incorrectly nested.
      */
@@ -182,7 +182,7 @@ public class JSONWriter {
 
     /**
      * End an object. This method most be called to balance calls to
-     * object.
+     * {@code object}.
      * @return this
      * @throws JSONException If incorrectly nested.
      */
@@ -222,8 +222,8 @@ public class JSONWriter {
 
     /**
      * Begin appending a new object. All keys and values until the balancing
-     * endObject will be appended to this object. The
-     * endObject method must be called to mark the object's end.
+     * {@code endObject} will be appended to this object. The
+     * {@code endObject} method must be called to mark the object's end.
      * @return this
      * @throws JSONException If the nesting is too deep, or if the object is
      * started in the wrong place (for example as a key or after the end of the
@@ -273,8 +273,8 @@ public class JSONWriter {
 
 
     /**
-     * Append either the value true or the value
-     * false.
+     * Append either the value {@code true} or the value
+     * {@code false}.
      * @param b A boolean.
      * @return this
      * @throws JSONException
diff --git a/api/src/main/java/org/json/Test.java b/api/src/main/java/org/json/Test.java
index e9e262475..a68e8146c 100644
--- a/api/src/main/java/org/json/Test.java
+++ b/api/src/main/java/org/json/Test.java
@@ -13,7 +13,7 @@ public class Test {
 
     /**
      * Entry point.
-     * @param args
+     * @param args Command line argumments
      */
     public static void main(String args[]) {
         Iterator it;
diff --git a/api/src/main/java/org/json/XML.java b/api/src/main/java/org/json/XML.java
index 2bce8ccd2..cb89036fe 100644
--- a/api/src/main/java/org/json/XML.java
+++ b/api/src/main/java/org/json/XML.java
@@ -35,40 +35,40 @@ import java.util.Iterator;
  */
 public class XML {
 
-    /** The Character '&'. */
+    /* The Character '&'. */
     public static final Character AMP   = new Character('&');
 
-    /** The Character '''. */
+    /* The Character '''. */
     public static final Character APOS  = new Character('\'');
 
-    /** The Character '!'. */
+    /* The Character '!'. */
     public static final Character BANG  = new Character('!');
 
-    /** The Character '='. */
+    /* The Character '='. */
     public static final Character EQ    = new Character('=');
 
-    /** The Character '>'. */
+    /* The Character '>'. */
     public static final Character GT    = new Character('>');
 
-    /** The Character '<'. */
+    /* The Character '<'. */
     public static final Character LT    = new Character('<');
 
-    /** The Character '?'. */
+    /* The Character '?'. */
     public static final Character QUEST = new Character('?');
 
-    /** The Character '"'. */
+    /* The Character '"'. */
     public static final Character QUOT  = new Character('"');
 
-    /** The Character '/'. */
+    /* The Character '/'. */
     public static final Character SLASH = new Character('/');
 
     /**
      * Replace special characters with XML escapes:
      * 
-     * & (ampersand) is replaced by &amp;
-     * < (less than) is replaced by &lt;
-     * > (greater than) is replaced by &gt;
-     * " (double quote) is replaced by &quot;
+     * & (ampersand) is replaced by &amp;
+     * < (less than) is replaced by &lt;
+     * > (greater than) is replaced by &gt;
+     * " (double quote) is replaced by &quot;
      * 

      * @param string The string to be escaped.
      * @return The escaped string.
@@ -267,7 +267,7 @@ public class XML {
      * does not like to distinguish between elements and attributes.
      * Sequences of similar elements are represented as JSONArrays. Content
      * text may be placed in a "content" member. Comments, prologs, DTDs, and
-     * <[ [ ]]> are ignored.
+     * {@code <[ [ ]]>} are ignored.
      * @param string The source string.
      * @return A JSONObject containing the structured data from the XML string.
      * @throws JSONException
diff --git a/api/src/main/java/org/json/XMLTokener.java b/api/src/main/java/org/json/XMLTokener.java
index 4c18a9b3e..4c2880f69 100644
--- a/api/src/main/java/org/json/XMLTokener.java
+++ b/api/src/main/java/org/json/XMLTokener.java
@@ -57,8 +57,8 @@ public class XMLTokener extends JSONTokener {
 
     /**
      * Get the text in the CDATA block.
-     * @return The string up to the ]]>.
-     * @throws JSONException If the ]]> is not found.
+     * @return The string up to the {@code ]]>}.
+     * @throws JSONException If the {@code ]]>} is not found.
      */
     public String nextCDATA() throws JSONException {
         char         c;
@@ -82,10 +82,10 @@ public class XMLTokener extends JSONTokener {
 
     /**
      * Get the next XML outer token, trimming whitespace. There are two kinds
-     * of tokens: the '<' character which begins a markup tag, and the content
+     * of tokens: the character which begins a markup tag, and the content
      * text between markup tags.
      *
-     * @return  A string, or a '<' Character, or null if there is no more
+     * @return  A string, or a '<' Character, or null if there is no more
      * source text.
      * @throws JSONException
      */
@@ -119,7 +119,7 @@ public class XMLTokener extends JSONTokener {
 
     /**
      * Return the next entity. These entities are translated to Characters:
-     *     &  '  >  <  ".
+     *     {@code &  '  >  <  "}.
      * @param a An ampersand character.
      * @return  A Character or an entity String if the entity is not recognized.
      * @throws JSONException If missing ';' in XML entity.
@@ -143,9 +143,9 @@ public class XMLTokener extends JSONTokener {
 
 
     /**
-     * Returns the next XML meta token. This is used for skipping over 
-     * and  structures.
-     * @return Syntax characters (< > / = ! ?) are returned as
+     * Returns the next XML meta token.
+     *
+     * @return Syntax characters ({@code < > / = ! ?}) are returned as
      *  Character, and strings and names are returned as Boolean. We don't care
      *  what the values actually are.
      * @throws JSONException If a string is not properly closed or if the XML
@@ -210,7 +210,7 @@ public class XMLTokener extends JSONTokener {
 
     /**
      * Get the next XML Token. These tokens are found inside of angle
-     * brackets. It may be one of these characters: / > = ! ? or it
+     * brackets. It may be one of these characters: {@code / > = ! ?} or it
      * may be a string wrapped in single quotes or double quotes, or it may be a
      * name.
      * @return a String or a Character.
diff --git a/api/src/test/java/edu/cornell/mannlib/vitro/webapp/filestorage/impl/FileStorageImplTest.java b/api/src/test/java/edu/cornell/mannlib/vitro/webapp/filestorage/impl/FileStorageImplTest.java
index f37424548..c63d327b4 100644
--- a/api/src/test/java/edu/cornell/mannlib/vitro/webapp/filestorage/impl/FileStorageImplTest.java
+++ b/api/src/test/java/edu/cornell/mannlib/vitro/webapp/filestorage/impl/FileStorageImplTest.java
@@ -32,7 +32,6 @@ import edu.cornell.mannlib.vitro.webapp.modules.fileStorage.FileAlreadyExistsExc
 
 /**
  * Test the FileStorage methods. The zero-argument constructor was tested in
- * {@link FileStorageFactoryTest}.
  */
 public class FileStorageImplTest extends AbstractTestClass {
 	private static final List EMPTY_NAMESPACES = Collections
diff --git a/api/src/test/java/edu/cornell/mannlib/vitro/webapp/freemarker/loader/FreemarkerTemplateLoaderTest.java b/api/src/test/java/edu/cornell/mannlib/vitro/webapp/freemarker/loader/FreemarkerTemplateLoaderTest.java
index cd375cb8b..0ed381c79 100644
--- a/api/src/test/java/edu/cornell/mannlib/vitro/webapp/freemarker/loader/FreemarkerTemplateLoaderTest.java
+++ b/api/src/test/java/edu/cornell/mannlib/vitro/webapp/freemarker/loader/FreemarkerTemplateLoaderTest.java
@@ -261,9 +261,8 @@ public class FreemarkerTemplateLoaderTest {
 	 *            template we are looking for
 	 * @param expectedHowMany
 	 *            How many matches do we expect?
-	 * @param expectedBestFit
+	 * @param expectedBestFitString
 	 *            What should the best match turn out to be?
-	 * @throws IOException
 	 */
 	private void assertMatches(String searchTerm, int expectedHowMany,
 			String expectedBestFitString) {
diff --git a/api/src/test/java/edu/cornell/mannlib/vitro/webapp/imageprocessor/jai/JaiImageProcessorTester.java b/api/src/test/java/edu/cornell/mannlib/vitro/webapp/imageprocessor/jai/JaiImageProcessorTester.java
index aeb2092ae..016ebfb1f 100644
--- a/api/src/test/java/edu/cornell/mannlib/vitro/webapp/imageprocessor/jai/JaiImageProcessorTester.java
+++ b/api/src/test/java/edu/cornell/mannlib/vitro/webapp/imageprocessor/jai/JaiImageProcessorTester.java
@@ -84,8 +84,7 @@ public class JaiImageProcessorTester extends Frame {
 	}
 
 	/**
-	 * @param thumbStream
-	 * @return
+	 * @param thumbStream Thumbnail stream
 	 * @throws IOException
 	 * @throws FileNotFoundException
 	 */
diff --git a/api/src/test/java/edu/cornell/mannlib/vitro/webapp/searchindex/indexing/AdditionalURIsForClassGroupChangesTest.java b/api/src/test/java/edu/cornell/mannlib/vitro/webapp/searchindex/indexing/AdditionalURIsForClassGroupChangesTest.java
index 602f2dd4c..755cf1b18 100644
--- a/api/src/test/java/edu/cornell/mannlib/vitro/webapp/searchindex/indexing/AdditionalURIsForClassGroupChangesTest.java
+++ b/api/src/test/java/edu/cornell/mannlib/vitro/webapp/searchindex/indexing/AdditionalURIsForClassGroupChangesTest.java
@@ -32,7 +32,6 @@ public class AdditionalURIsForClassGroupChangesTest {
     }
 
     /**
-     * Test method for {@link edu.cornell.mannlib.vitro.webapp.search.indexing.AdditionalURIsForClassGroupChanges#findAdditionalURIsToIndex(com.hp.hpl.jena.rdf.model.Statement)}.
      */
     @Test
     public void testFindAdditionalURIsToIndex() {
diff --git a/api/src/test/java/edu/cornell/mannlib/vitro/webapp/searchindex/indexing/AdditionalURIsForTypeStatementsTest.java b/api/src/test/java/edu/cornell/mannlib/vitro/webapp/searchindex/indexing/AdditionalURIsForTypeStatementsTest.java
index 25ead970b..30db6ddb0 100644
--- a/api/src/test/java/edu/cornell/mannlib/vitro/webapp/searchindex/indexing/AdditionalURIsForTypeStatementsTest.java
+++ b/api/src/test/java/edu/cornell/mannlib/vitro/webapp/searchindex/indexing/AdditionalURIsForTypeStatementsTest.java
@@ -25,7 +25,6 @@ public class AdditionalURIsForTypeStatementsTest {
     }
 
     /**
-     * Test method for {@link edu.cornell.mannlib.vitro.webapp.search.indexing.AdditionalURIsForTypeStatements#findAdditionalURIsToIndex(com.hp.hpl.jena.rdf.model.Statement)}.
      */
     @Test
     public void testFindAdditionalURIsToIndex() {
diff --git a/api/src/test/java/edu/cornell/mannlib/vitro/webapp/test/JenaOntologyLoader.java b/api/src/test/java/edu/cornell/mannlib/vitro/webapp/test/JenaOntologyLoader.java
index 237f99058..8e9146df4 100644
--- a/api/src/test/java/edu/cornell/mannlib/vitro/webapp/test/JenaOntologyLoader.java
+++ b/api/src/test/java/edu/cornell/mannlib/vitro/webapp/test/JenaOntologyLoader.java
@@ -22,8 +22,7 @@ public class JenaOntologyLoader {
      * This should load the system with classes, data properties and
      * object properties that the vitro systems needs.
      *  
-     * @return
-     * @throws Exception 
+     * @throws Exception
      */
     OntModel loadSystemAndUsers() throws Exception{        
         Model model = ModelFactory.createDefaultModel();        
@@ -42,8 +41,7 @@ public class JenaOntologyLoader {
      * Loads a owl file into the ontModel.  Looks for files on classpath.
      * example: loadSpecialVivoModel("/testontologies/smallVivo-20070809.owl") 
      * 
-     * @param junk
-     * @return
+     * @param junk Junk value
      * @throws IOException
      */
     OntModel loadSpecialVivoModel(String junk) throws IOException{
diff --git a/api/src/test/java/stubs/edu/cornell/mannlib/vitro/webapp/modules/searchEngine/SearchQueryStub.java b/api/src/test/java/stubs/edu/cornell/mannlib/vitro/webapp/modules/searchEngine/SearchQueryStub.java
index d24e3ec26..bcd0c3be2 100644
--- a/api/src/test/java/stubs/edu/cornell/mannlib/vitro/webapp/modules/searchEngine/SearchQueryStub.java
+++ b/api/src/test/java/stubs/edu/cornell/mannlib/vitro/webapp/modules/searchEngine/SearchQueryStub.java
@@ -13,14 +13,13 @@ public class SearchQueryStub extends BaseSearchQuery {
 	// ----------------------------------------------------------------------
 
 	/**
-	 * @param queryText
 	 */
 	public SearchQueryStub() {
 		super();
 	}
 
 	/**
-	 * @param queryText
+	 * @param queryText Query text
 	 */
 	public SearchQueryStub(String queryText) {
 		super();