Skip to main content
summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorcbateman2007-04-09 02:23:06 +0000
committercbateman2007-04-09 02:23:06 +0000
commit75387c43021f3f19b73ac3f80309939151434e56 (patch)
treede34375ec5a65f6e1b06e069a9c599454fe6e8f3 /jsf/plugins/org.eclipse.jst.pagedesigner/src/org/eclipse/jst/pagedesigner/converter
parente5542cefd91103dd3cfd0e4d2001e03e3bb5ae66 (diff)
downloadwebtools.jsf-75387c43021f3f19b73ac3f80309939151434e56.tar.gz
webtools.jsf-75387c43021f3f19b73ac3f80309939151434e56.tar.xz
webtools.jsf-75387c43021f3f19b73ac3f80309939151434e56.zip
Increased warnings and error level on code and Javadoc compliance.
Fixed new errors and some warnings.
Diffstat (limited to 'jsf/plugins/org.eclipse.jst.pagedesigner/src/org/eclipse/jst/pagedesigner/converter')
-rw-r--r--jsf/plugins/org.eclipse.jst.pagedesigner/src/org/eclipse/jst/pagedesigner/converter/AbstractTagConverter.java6
-rw-r--r--jsf/plugins/org.eclipse.jst.pagedesigner/src/org/eclipse/jst/pagedesigner/converter/ConverterUtil.java2
-rw-r--r--jsf/plugins/org.eclipse.jst.pagedesigner/src/org/eclipse/jst/pagedesigner/converter/DumDeepTagConverter.java4
-rw-r--r--jsf/plugins/org.eclipse.jst.pagedesigner/src/org/eclipse/jst/pagedesigner/converter/IDOMFactory.java4
-rw-r--r--jsf/plugins/org.eclipse.jst.pagedesigner/src/org/eclipse/jst/pagedesigner/converter/ITagConverter.java24
5 files changed, 15 insertions, 25 deletions
diff --git a/jsf/plugins/org.eclipse.jst.pagedesigner/src/org/eclipse/jst/pagedesigner/converter/AbstractTagConverter.java b/jsf/plugins/org.eclipse.jst.pagedesigner/src/org/eclipse/jst/pagedesigner/converter/AbstractTagConverter.java
index 0f5f01d76..0d34b94fc 100644
--- a/jsf/plugins/org.eclipse.jst.pagedesigner/src/org/eclipse/jst/pagedesigner/converter/AbstractTagConverter.java
+++ b/jsf/plugins/org.eclipse.jst.pagedesigner/src/org/eclipse/jst/pagedesigner/converter/AbstractTagConverter.java
@@ -240,7 +240,7 @@ public abstract class AbstractTagConverter implements ITagConverter,
* In the future, the conversion result HTML DOM tree could be in another
* document.
*
- * @return
+ * @return the destination document
*/
public IDOMDocument getDestDocument() {
if (this._targetDocument != null) {
@@ -254,7 +254,7 @@ public abstract class AbstractTagConverter implements ITagConverter,
* result element.
*
* @param tagName
- * @return
+ * @return a new element named tagName
*/
public Element createElement(String tagName) {
return getDestDocument().createElement(tagName);
@@ -265,7 +265,7 @@ public abstract class AbstractTagConverter implements ITagConverter,
* text node.
*
* @param text
- * @return
+ * @return a new text node using text as the value
*/
public Text createText(String text) {
return getDestDocument().createTextNode(text);
diff --git a/jsf/plugins/org.eclipse.jst.pagedesigner/src/org/eclipse/jst/pagedesigner/converter/ConverterUtil.java b/jsf/plugins/org.eclipse.jst.pagedesigner/src/org/eclipse/jst/pagedesigner/converter/ConverterUtil.java
index b082303c9..2dd26785e 100644
--- a/jsf/plugins/org.eclipse.jst.pagedesigner/src/org/eclipse/jst/pagedesigner/converter/ConverterUtil.java
+++ b/jsf/plugins/org.eclipse.jst.pagedesigner/src/org/eclipse/jst/pagedesigner/converter/ConverterUtil.java
@@ -63,7 +63,7 @@ public class ConverterUtil {
/**
* @param hostElement
- * @return
+ * @return true if hostElement represents an empty container
*/
public static boolean isEmptyContainer(Element hostElement) {
NodeList nl = hostElement.getChildNodes();
diff --git a/jsf/plugins/org.eclipse.jst.pagedesigner/src/org/eclipse/jst/pagedesigner/converter/DumDeepTagConverter.java b/jsf/plugins/org.eclipse.jst.pagedesigner/src/org/eclipse/jst/pagedesigner/converter/DumDeepTagConverter.java
index 079487bcd..0a56b529f 100644
--- a/jsf/plugins/org.eclipse.jst.pagedesigner/src/org/eclipse/jst/pagedesigner/converter/DumDeepTagConverter.java
+++ b/jsf/plugins/org.eclipse.jst.pagedesigner/src/org/eclipse/jst/pagedesigner/converter/DumDeepTagConverter.java
@@ -46,10 +46,6 @@ public class DumDeepTagConverter extends AbstractTagConverter {
return true;
}
- /**
- * @param result
- * @return
- */
// TODO: dead?
// private boolean internalIsWidget(Element result) {
// String tagname = result.getTagName();
diff --git a/jsf/plugins/org.eclipse.jst.pagedesigner/src/org/eclipse/jst/pagedesigner/converter/IDOMFactory.java b/jsf/plugins/org.eclipse.jst.pagedesigner/src/org/eclipse/jst/pagedesigner/converter/IDOMFactory.java
index dd0748990..3e3d374ed 100644
--- a/jsf/plugins/org.eclipse.jst.pagedesigner/src/org/eclipse/jst/pagedesigner/converter/IDOMFactory.java
+++ b/jsf/plugins/org.eclipse.jst.pagedesigner/src/org/eclipse/jst/pagedesigner/converter/IDOMFactory.java
@@ -25,7 +25,7 @@ public interface IDOMFactory {
* create element
*
* @param tag
- * @return
+ * @return a new element using tag as its name
*/
public Element createElement(String tag);
@@ -33,7 +33,7 @@ public interface IDOMFactory {
* create text node
*
* @param content
- * @return
+ * @return a new text node using content as its body
*/
public Text createText(String content);
}
diff --git a/jsf/plugins/org.eclipse.jst.pagedesigner/src/org/eclipse/jst/pagedesigner/converter/ITagConverter.java b/jsf/plugins/org.eclipse.jst.pagedesigner/src/org/eclipse/jst/pagedesigner/converter/ITagConverter.java
index 761e7d2ea..b5aea5362 100644
--- a/jsf/plugins/org.eclipse.jst.pagedesigner/src/org/eclipse/jst/pagedesigner/converter/ITagConverter.java
+++ b/jsf/plugins/org.eclipse.jst.pagedesigner/src/org/eclipse/jst/pagedesigner/converter/ITagConverter.java
@@ -42,9 +42,7 @@ public interface ITagConverter {
public void convertRefresh(Object context);
/**
- * The host element being converted.
- *
- * @return
+ * @return The host element being converted.
*/
public Element getHostElement();
@@ -54,7 +52,7 @@ public interface ITagConverter {
* should return an image in <code>getVisualImage()</code> for displaying
* in the designer.
*
- * @return
+ * @return true if the tag represents something that will be rendered visually at runtime
*/
public boolean isVisualByHTML();
@@ -66,21 +64,17 @@ public interface ITagConverter {
* is this class's responsibility to dispose the image if the image is not a
* shared one.
*
- * @return
+ * @return the placeholder image for non-visual tags
*/
public Image getVisualImage();
/**
- * the element after conversion.
- *
- * @return
+ * @return the result element after conversion
*/
public Element getResultElement();
/**
- * get the list of children that should be continuely converted.
- *
- * @return
+ * @return the list of children that should be continuely converted.
*/
public List getChildModeList();
@@ -95,7 +89,7 @@ public interface ITagConverter {
* converted DOM tree.
*
* @param childModel
- * @return
+ * @return the position of child nodes
*/
public ConvertPosition getChildVisualPosition(Node childModel);
@@ -104,18 +98,18 @@ public interface ITagConverter {
* false, then the caller should not use child nodes of
* <code>getHostElement()</code>
*
- * @return
+ * @return true if the host element has convertable children
*/
public boolean isMultiLevel();
/**
*
- * @return
+ * @return true if the host element is a widget
*/
public boolean isWidget();
/**
- *
+ * API contract needed here
*
*/
public void dispose();

Back to the top