Fix JavaDocs for number of classes

PhantomYdn · PhantomYdn · commit 883c17f4ecde · 2017-01-07T22:55:36.000-08:00
diff --git a/orienteer-camel/src/main/java/org/orienteer/camel/component/OrientDBEndpoint.java b/orienteer-camel/src/main/java/org/orienteer/camel/component/OrientDBEndpoint.java
@@ -222,7 +222,8 @@ public String getFetchPlan() {
 	}
 
 	/**
-	 * Set fetch plan (wiew orientdb documentation, like http://orientdb.com/docs/2.0/orientdb.wiki/Fetching-Strategies.html) 
+	 * Set fetch plan (view orientdb documentation, like http://orientdb.com/docs/2.0/orientdb.wiki/Fetching-Strategies.html)
+	 * @param fetchPlan fetch plan to be used 
 	 */
 	public void setFetchPlan(String fetchPlan) {
 		this.fetchPlan = fetchPlan;
@@ -234,6 +235,7 @@ public String getInputAsOClass() {
 
 	/**
 	 * Rewrite "@class" field in root document(s) 
+	 * @param inputAsOClass value to be used for rewriting
 	 */
 	public void setInputAsOClass(String inputAsOClass) {
 		this.inputAsOClass = inputAsOClass;
@@ -245,6 +247,7 @@ public boolean isPreload() {
 
 	/**
 	 * Save ODocument from input data BEFORE query   
+	 * @param preload preloading flag
 	 */
 	public void setPreload(boolean preload) {
 		this.preload = preload;
@@ -256,6 +259,7 @@ public boolean isMakeNew() {
 
 	/**
 	 * Clear ODocuments RID`s in PRELOAD phase BEFORE save
+	 * @param makeNew should document be created as new
 	 */
 	public void setMakeNew(boolean makeNew) {
 		this.makeNew = makeNew;
@@ -268,7 +272,7 @@ public OrientDBCamelDataType getOutputType() {
 	/**
 	 * Output data type of single row. Can be "map", "object", "list" or "json" 
 	 * Default value - "map"
-	 * 
+	 * @param outputType output type
 	 */
 	public void setOutputType(OrientDBCamelDataType outputType) {
 		this.outputType = outputType;
@@ -279,7 +283,8 @@ public int getMaxDepth() {
 	}
 
 	/**
-	 *	Max fetch depth. Only for "map" type 
+	 * Max fetch depth. Only for "map" type 
+	 * @param maxDepth max depth to be loaded
 	 */
 	public void setMaxDepth(int maxDepth) {
 		this.maxDepth = maxDepth;
@@ -290,7 +295,8 @@ public boolean isFetchAllEmbedded() {
 	}
 
 	/**
-	 *	Fetch all embedded(not linked) objects, ignore "maxDepth". Only for "map" type. 
+	 * Fetch all embedded(not linked) objects, ignore "maxDepth". Only for "map" type. 
+	 * @param fetchAllEmbedded should all embedded be fetched?
 	 */
 	public void setFetchAllEmbedded(boolean fetchAllEmbedded) {
 		this.fetchAllEmbedded = fetchAllEmbedded;
diff --git a/orienteer-core/src/main/java/org/orienteer/core/component/IExportable.java b/orienteer-core/src/main/java/org/orienteer/core/component/IExportable.java
@@ -4,7 +4,7 @@
 
 /**
  * Interface to mark components which might be exportable within data-tables
- * @param <V>
+ * @param <V> value type
  */
 public interface IExportable<V> {
 	public IModel<? extends V> getExportableDataModel();
diff --git a/orienteer-core/src/main/java/org/orienteer/core/component/command/ExportCommand.java b/orienteer-core/src/main/java/org/orienteer/core/component/command/ExportCommand.java
@@ -18,7 +18,7 @@
 
 /**
  * Command to export data into default format 
- * @param <T>
+ * @param <T> the type of an entity to which this command can be applied
  */
 public class ExportCommand <T> extends Command<T> {
 	
diff --git a/orienteer-core/src/main/java/org/orienteer/core/component/command/SaveSchemaCommand.java b/orienteer-core/src/main/java/org/orienteer/core/component/command/SaveSchemaCommand.java
@@ -22,7 +22,7 @@
 /**
  * {@link Command} to save a schema specific entities: {@link OClass}, {@link OProperty}, {@link OIndex} 
  *
- * @param <T>
+ * @param <T> the type of an entity to which this command can be applied
  */
 public class SaveSchemaCommand<T> extends SavePrototypeCommand<T> implements ISecuredComponent {
 
diff --git a/orienteer-core/src/main/java/org/orienteer/core/component/command/ShowHideParentsCommand.java b/orienteer-core/src/main/java/org/orienteer/core/component/command/ShowHideParentsCommand.java
@@ -32,7 +32,7 @@ protected void onConfigure() {
 		if(classModel!=null)
 		{
 			OClass oClass = classModel.getObject();
-			setVisible(oClass!=null && oClass.getSuperClass()!=null);
+			setVisible(oClass!=null && oClass.hasSuperClasses());
 		}
 	}
 
diff --git a/orienteer-core/src/main/java/org/orienteer/core/component/property/AbstractLinkViewPanel.java b/orienteer-core/src/main/java/org/orienteer/core/component/property/AbstractLinkViewPanel.java
@@ -8,7 +8,7 @@
 /**
  * {@link GenericPanel} for displaying of {@link Link}s
  *
- * @param <T>
+ * @param <T> the type of the panel's model object
  */
 public abstract class AbstractLinkViewPanel<T> extends GenericPanel<T> {
 
diff --git a/orienteer-core/src/main/java/org/orienteer/core/component/property/BinaryViewPanel.java b/orienteer-core/src/main/java/org/orienteer/core/component/property/BinaryViewPanel.java
@@ -20,7 +20,7 @@
 /**
  * {@link GenericPanel} to view binary parameters (download)
  *
- * @param <V>
+ * @param <V> the type of the panel's model object
  */
 public class BinaryViewPanel<V> extends GenericPanel<V> {
 	
diff --git a/orienteer-core/src/main/java/org/orienteer/core/component/property/ImageViewPanel.java b/orienteer-core/src/main/java/org/orienteer/core/component/property/ImageViewPanel.java
@@ -10,7 +10,7 @@
 /**
  * {@link GenericPanel} to view binary images
  *
- * @param <V>
+ * @param <V> the type of the panel's model object
  */
 public class ImageViewPanel<V> extends GenericPanel<V> {
 
diff --git a/orienteer-core/src/main/java/org/orienteer/core/component/structuretable/StructureTable.java b/orienteer-core/src/main/java/org/orienteer/core/component/structuretable/StructureTable.java
@@ -7,6 +7,7 @@
 import org.apache.wicket.ajax.AjaxRequestTarget;
 import org.apache.wicket.event.Broadcast;
 import org.apache.wicket.event.IEvent;
+import org.apache.wicket.extensions.markup.html.repeater.data.table.DataTable;
 import org.apache.wicket.markup.ComponentTag;
 import org.apache.wicket.markup.html.WebMarkupContainer;
 import org.apache.wicket.markup.html.basic.Label;
@@ -219,7 +220,7 @@ public void component(Component object, IVisit<Boolean> visit)
 	}
 
 	/**
-	 * A caption for the table. It renders itself only if {@link DataTable#getCaptionModel()} has
+	 * A caption for the table. It renders itself only if {@link DataTable} caption has
 	 * non-empty value.
 	 */
 	private static class Caption extends Label
diff --git a/orienteer-core/src/main/java/org/orienteer/core/component/structuretable/StructureTableCommandsToolbar.java b/orienteer-core/src/main/java/org/orienteer/core/component/structuretable/StructureTableCommandsToolbar.java
@@ -10,7 +10,7 @@
 /**
  * {@link AbstractStructureTableToolbar} to add {@link Command}s
  *
- * @param <P>
+ * @param <P> the type of main object for a commands
  */
 public class StructureTableCommandsToolbar<P> extends
 		AbstractStructureTableToolbar<P> implements ICommandsSupportComponent<P>
diff --git a/orienteer-core/src/main/java/org/orienteer/core/component/widget/document/ExternalPageWidget.java b/orienteer-core/src/main/java/org/orienteer/core/component/widget/document/ExternalPageWidget.java
@@ -1,5 +1,6 @@
 package org.orienteer.core.component.widget.document;
 
+import com.google.common.base.MoreObjects;
 import com.google.common.base.Objects;
 import com.google.common.base.Strings;
 import com.orientechnologies.orient.core.record.impl.ODocument;
@@ -72,8 +73,8 @@ public void loadSettings() {
         ODocument doc = getWidgetDocument();
         if(doc==null) return;
 
-        externalPageUrl = (String)Objects.firstNonNull(doc.field(OPROPERTY_PAGE_URL), "");
-        style = (String)Objects.firstNonNull(doc.field(OPROPERTY_STYLE), "");
+        externalPageUrl = (String)MoreObjects.firstNonNull(doc.field(OPROPERTY_PAGE_URL), "");
+        style = (String)MoreObjects.firstNonNull(doc.field(OPROPERTY_STYLE), "");
     }
 
     @Override
diff --git a/orienteer-core/src/main/java/org/orienteer/core/model/LanguagesChoiceProvider.java b/orienteer-core/src/main/java/org/orienteer/core/model/LanguagesChoiceProvider.java
@@ -4,6 +4,7 @@
 import java.util.Locale;
 
 import org.apache.wicket.util.string.Strings;
+import org.wicketstuff.select2.ChoiceProvider;
 import org.wicketstuff.select2.Response;
 import org.wicketstuff.select2.StringTextChoiceProvider;
 
@@ -12,7 +13,7 @@
 import com.google.common.collect.ImmutableList;
 
 /**
- * {@link com.vaynberg.wicket.select2.ChoiceProvider} for combobox of language codes.
+ * {@link ChoiceProvider} for combobox of language codes.
  */
 public class LanguagesChoiceProvider extends StringTextChoiceProvider {
     private static final List<String> ISO_LANGUAGES = ImmutableList.copyOf(Locale.getISOLanguages());
diff --git a/orienteer-core/src/main/java/org/orienteer/core/model/OClassTextChoiceProvider.java b/orienteer-core/src/main/java/org/orienteer/core/model/OClassTextChoiceProvider.java
@@ -13,7 +13,7 @@
 import com.orientechnologies.orient.core.metadata.schema.OClass;
 
 /**
- * {@link TextChoiceProvider} for {@link OClass}es
+ * {@link ChoiceProvider} for {@link OClass}es
  */
 public class OClassTextChoiceProvider extends ChoiceProvider<OClass> {
 	
diff --git a/orienteer-core/src/main/java/org/orienteer/core/model/OnCreateFieldsTextChoiceProvider.java b/orienteer-core/src/main/java/org/orienteer/core/model/OnCreateFieldsTextChoiceProvider.java
@@ -12,7 +12,7 @@
 import org.wicketstuff.select2.StringTextChoiceProvider;
 
 /**
- * {@link TextChoiceProvider} for "onCreate.fields" multiSelect.
+ * {@link StringTextChoiceProvider} for "onCreate.fields" multiSelect.
  */
 public class OnCreateFieldsTextChoiceProvider extends StringTextChoiceProvider {
 
diff --git a/orienteer-core/src/main/java/org/orienteer/core/module/IOrienteerModule.java b/orienteer-core/src/main/java/org/orienteer/core/module/IOrienteerModule.java
@@ -52,7 +52,7 @@ public interface IOrienteerModule
 	 * @param moduleDoc module {@link ODocument}
 	 * @param oldVersion previous version
 	 * @param newVersion new version
-	 * @return
+	 * @return {@link ODocument} of a module or null if document was not exchanged
 	 */
 	public ODocument onUpdate(OrienteerWebApplication app, ODatabaseDocument db, ODocument moduleDoc, int oldVersion, int newVersion);
 	
diff --git a/orienteer-core/src/main/java/org/orienteer/core/service/OrienteerModule.java b/orienteer-core/src/main/java/org/orienteer/core/service/OrienteerModule.java
@@ -49,8 +49,6 @@
  * <h1>Properties</h1>
  * Properties can be retrieved from both files from the local filesystem and
  * files on the Java classpath. 
- * System property {@link #ORIENTEER_PROPERTIES_QUALIFIER_PROPERTY_NAME} defines
- * qualifier which should be used in properties lookup.
  * Highlevel lookup:
  * <ol>
  * <li>If there is a qualifier - lookup by this qualifier</li>
diff --git a/orienteer-core/src/main/java/org/orienteer/core/util/LookupResourceHelper.java b/orienteer-core/src/main/java/org/orienteer/core/util/LookupResourceHelper.java
@@ -171,8 +171,8 @@ public URL lookup(String identifier) {
 	
 	/**
 	 * Utility method to convert file to URL
-	 * @param file
-	 * @return
+	 * @param file local for
+	 * @return URL of a provided file
 	 */
 	public static URL convertFileToURL(File file)
 	{
diff --git a/orienteer-core/src/main/java/org/orienteer/core/web/AbstractWidgetDisplayModeAwarePage.java b/orienteer-core/src/main/java/org/orienteer/core/web/AbstractWidgetDisplayModeAwarePage.java
@@ -8,7 +8,7 @@
 /**
  * {@link AbstractWidgetPage} plus generic stuff for pages which can have a deal with {@link DisplayMode}
  *
- * @param <T>
+ * @param <T> the type of a main object for this page
  */
 public abstract class AbstractWidgetDisplayModeAwarePage<T> extends AbstractWidgetPage<T> implements IDisplayModeAware {
 
diff --git a/orienteer-core/src/main/java/org/orienteer/core/widget/AbstractWidget.java b/orienteer-core/src/main/java/org/orienteer/core/widget/AbstractWidget.java
@@ -26,6 +26,7 @@
 import ru.ydn.wicket.wicketorientdb.model.NvlModel;
 import ru.ydn.wicket.wicketorientdb.model.ODocumentPropertyModel;
 
+import com.google.common.base.MoreObjects;
 import com.google.common.base.Objects;
 import com.orientechnologies.orient.core.db.document.ODatabaseDocument;
 import com.orientechnologies.orient.core.metadata.schema.OSchema;
@@ -160,7 +161,7 @@ public void setHidden(boolean hidden) {
 	public void loadSettings() {
 		ODocument doc = widgetDocumentModel.getObject();
 		if(doc==null) return;
-		hidden = Objects.firstNonNull((Boolean)doc.field(OPROPERTY_HIDDEN), false);
+		hidden = MoreObjects.firstNonNull((Boolean)doc.field(OPROPERTY_HIDDEN), false);
 		getDashboardPanel().getDashboardSupport().loadSettings(this, doc);
 	}
 	
diff --git a/orienteer-core/src/main/java/org/orienteer/core/widget/command/FullScreenCommand.java b/orienteer-core/src/main/java/org/orienteer/core/widget/command/FullScreenCommand.java
@@ -8,7 +8,7 @@
 
 /**
  * Command to make widget fullscreen and back 
- * @param <T>
+ * @param <T> the type of an entity to which this command can be applied
  */
 public class FullScreenCommand<T> extends AjaxCommand<T> {
 	
diff --git a/orienteer-core/src/main/java/org/orienteer/core/widget/support/gridster/GridsterWidgetBehavior.java b/orienteer-core/src/main/java/org/orienteer/core/widget/support/gridster/GridsterWidgetBehavior.java
@@ -13,6 +13,7 @@
 import org.apache.wicket.util.lang.Args;
 import org.orienteer.core.widget.AbstractWidget;
 
+import com.google.common.base.MoreObjects;
 import com.google.common.base.Objects;
 import com.orientechnologies.orient.core.record.impl.ODocument;
 
@@ -110,9 +111,9 @@ public void saveSettings(ODocument doc) {
 	}
 	
 	public void loadSettings(ODocument doc) {
-		row = Objects.firstNonNull((Integer)doc.field(OPROPERTY_ROW), 1);
-		col = Objects.firstNonNull((Integer)doc.field(OPROPERTY_COL), 1);
-		sizeX = Objects.firstNonNull((Integer)doc.field(OPROPERTY_SIZE_X), 2);
-		sizeY = Objects.firstNonNull((Integer)doc.field(OPROPERTY_SIZE_Y), 1);
+		row = MoreObjects.firstNonNull((Integer)doc.field(OPROPERTY_ROW), 1);
+		col = MoreObjects.firstNonNull((Integer)doc.field(OPROPERTY_COL), 1);
+		sizeX = MoreObjects.firstNonNull((Integer)doc.field(OPROPERTY_SIZE_X), 2);
+		sizeY = MoreObjects.firstNonNull((Integer)doc.field(OPROPERTY_SIZE_Y), 1);
 	}
 }
diff --git a/orienteer-devutils/src/main/java/org/orienteer/devutils/ODBScriptEngine.java b/orienteer-devutils/src/main/java/org/orienteer/devutils/ODBScriptEngine.java
@@ -30,6 +30,7 @@ public String getName() {
 		return ODBScriptEngineFactory.ENGINE_NAME;
 	}
 
+	@SuppressWarnings("unchecked")
 	@Override
 	public ScriptResult eval(String command) {
 		ScriptResult result = new ScriptResult(ODBScriptEngineFactory.ENGINE_NAME, command);
diff --git a/orienteer-graph/src/main/java/org/orienteer/graph/component/widget/GraphVerticesWidget.java b/orienteer-graph/src/main/java/org/orienteer/graph/component/widget/GraphVerticesWidget.java
@@ -36,6 +36,7 @@ public class GraphVerticesWidget extends AbstractWidget<ODocument> {
     @Inject
     private OClassIntrospector oClassIntrospector;
 
+    @SuppressWarnings("unchecked")
     public GraphVerticesWidget(String id, final IModel<ODocument> model, IModel<ODocument> widgetDocumentModel) {
         super(id, model, widgetDocumentModel);
 
diff --git a/orienteer-logger-server/src/main/java/org/orienteer/logger/server/rest/OLoggerReceiverResource.java b/orienteer-logger-server/src/main/java/org/orienteer/logger/server/rest/OLoggerReceiverResource.java
@@ -22,9 +22,7 @@
 import ru.ydn.wicket.wicketorientdb.utils.DBClosure;
 
 /**
- * 
- * Data provider for {@link OIncidentReceiver}. 
- * 
+ * REST entry point of OLogger events 
  */
 public class OLoggerReceiverResource extends AbstractResource {
 	/**

Original file line number	Diff line number	Diff line change
`@@ -22,7 +22,7 @@`
`22`	`22`	`/**`
`23`	`23`	`* {@link Command} to save a schema specific entities: {@link OClass}, {@link OProperty}, {@link OIndex}`
`24`	`24`	`*`
`25`		`- * @param <T>`
	`25`	`+ * @param <T> the type of an entity to which this command can be applied`
`26`	`26`	`*/`
`27`	`27`	`public class SaveSchemaCommand<T> extends SavePrototypeCommand<T> implements ISecuredComponent {`
`28`	`28`
Original file line number	Diff line number	Diff line change
`@@ -32,7 +32,7 @@ protected void onConfigure() {`
`32`	`32`	`if(classModel!=null)`
`33`	`33`	`{`
`34`	`34`	`OClass oClass = classModel.getObject();`
`35`		`- setVisible(oClass!=null && oClass.getSuperClass()!=null);`
	`35`	`+ setVisible(oClass!=null && oClass.hasSuperClasses());`
`36`	`36`	`}`
`37`	`37`	`}`
`38`	`38`
Original file line number	Diff line number	Diff line change
`@@ -8,7 +8,7 @@`
`8`	`8`	`/**`
`9`	`9`	`* {@link GenericPanel} for displaying of {@link Link}s`
`10`	`10`	`*`
`11`		`- * @param <T>`
	`11`	`+ * @param <T> the type of the panel's model object`
`12`	`12`	`*/`
`13`	`13`	`public abstract class AbstractLinkViewPanel<T> extends GenericPanel<T> {`
`14`	`14`
Original file line number	Diff line number	Diff line change
`@@ -20,7 +20,7 @@`
`20`	`20`	`/**`
`21`	`21`	`* {@link GenericPanel} to view binary parameters (download)`
`22`	`22`	`*`
`23`		`- * @param <V>`
	`23`	`+ * @param <V> the type of the panel's model object`
`24`	`24`	`*/`
`25`	`25`	`public class BinaryViewPanel<V> extends GenericPanel<V> {`
`26`	`26`
Original file line number	Diff line number	Diff line change
`@@ -10,7 +10,7 @@`
`10`	`10`	`/**`
`11`	`11`	`* {@link GenericPanel} to view binary images`
`12`	`12`	`*`
`13`		`- * @param <V>`
	`13`	`+ * @param <V> the type of the panel's model object`
`14`	`14`	`*/`
`15`	`15`	`public class ImageViewPanel<V> extends GenericPanel<V> {`
`16`	`16`