Author: cziegeler
Date: Thu Dec 6 04:48:09 2007
New Revision: 601722
URL: http://svn.apache.org/viewvc?rev=601722&view=rev
Log:
Correct javadocs.
Modified:
felix/trunk/scrplugin/src/main/java/org/apache/felix/scrplugin/SCRDescriptorMojo.java
felix/trunk/scrplugin/src/main/java/org/apache/felix/scrplugin/om/AbstractObject.java
felix/trunk/scrplugin/src/main/java/org/apache/felix/scrplugin/om/Component.java
felix/trunk/scrplugin/src/main/java/org/apache/felix/scrplugin/om/metatype/AttributeDefinition.java
felix/trunk/scrplugin/src/main/java/org/apache/felix/scrplugin/tags/JavaClassDescription.java
felix/trunk/scrplugin/src/main/java/org/apache/felix/scrplugin/tags/JavaClassDescriptorManager.java
Modified:
felix/trunk/scrplugin/src/main/java/org/apache/felix/scrplugin/SCRDescriptorMojo.java
URL:
http://svn.apache.org/viewvc/felix/trunk/scrplugin/src/main/java/org/apache/felix/scrplugin/SCRDescriptorMojo.java?rev=601722&r1=601721&r2=601722&view=diff
==============================================================================
---
felix/trunk/scrplugin/src/main/java/org/apache/felix/scrplugin/SCRDescriptorMojo.java
(original)
+++
felix/trunk/scrplugin/src/main/java/org/apache/felix/scrplugin/SCRDescriptorMojo.java
Thu Dec 6 04:48:09 2007
@@ -404,7 +404,6 @@
* @param services
* @param component
* @param description
- * @return
* @throws MojoExecutionException
*/
protected void doServices(JavaTag[] services, Component component,
JavaClassDescription description)
Modified:
felix/trunk/scrplugin/src/main/java/org/apache/felix/scrplugin/om/AbstractObject.java
URL:
http://svn.apache.org/viewvc/felix/trunk/scrplugin/src/main/java/org/apache/felix/scrplugin/om/AbstractObject.java?rev=601722&r1=601721&r2=601722&view=diff
==============================================================================
---
felix/trunk/scrplugin/src/main/java/org/apache/felix/scrplugin/om/AbstractObject.java
(original)
+++
felix/trunk/scrplugin/src/main/java/org/apache/felix/scrplugin/om/AbstractObject.java
Thu Dec 6 04:48:09 2007
@@ -35,8 +35,7 @@
protected String getMessage(String message) {
if ( this.tag == null ) {
return message;
- } else {
- return "@" + this.tag.getName() + ": " + message + " (" +
this.tag.getSourceLocation() + ")";
}
+ return "@" + this.tag.getName() + ": " + message + " (" +
this.tag.getSourceLocation() + ")";
}
}
Modified:
felix/trunk/scrplugin/src/main/java/org/apache/felix/scrplugin/om/Component.java
URL:
http://svn.apache.org/viewvc/felix/trunk/scrplugin/src/main/java/org/apache/felix/scrplugin/om/Component.java?rev=601722&r1=601721&r2=601722&view=diff
==============================================================================
---
felix/trunk/scrplugin/src/main/java/org/apache/felix/scrplugin/om/Component.java
(original)
+++
felix/trunk/scrplugin/src/main/java/org/apache/felix/scrplugin/om/Component.java
Thu Dec 6 04:48:09 2007
@@ -90,7 +90,7 @@
}
/**
- * @return
+ * @return All properties of this component.
*/
public List getProperties() {
return this.properties;
Modified:
felix/trunk/scrplugin/src/main/java/org/apache/felix/scrplugin/om/metatype/AttributeDefinition.java
URL:
http://svn.apache.org/viewvc/felix/trunk/scrplugin/src/main/java/org/apache/felix/scrplugin/om/metatype/AttributeDefinition.java?rev=601722&r1=601721&r2=601722&view=diff
==============================================================================
---
felix/trunk/scrplugin/src/main/java/org/apache/felix/scrplugin/om/metatype/AttributeDefinition.java
(original)
+++
felix/trunk/scrplugin/src/main/java/org/apache/felix/scrplugin/om/metatype/AttributeDefinition.java
Thu Dec 6 04:48:09 2007
@@ -23,7 +23,7 @@
public class AttributeDefinition {
public static final String DEFAULT_TYPE = "String";
-
+
protected String id;
protected String type = DEFAULT_TYPE;
@@ -74,7 +74,7 @@
if (values != null) {
this.defaultValue = null;
this.defaultMultiValue = values;
- if (values != null && values.length > 0 && this.cardinality ==
null ) {
+ if (values.length > 0 && this.cardinality == null ) {
this.cardinality = new Integer(Integer.MAX_VALUE);
}
}
Modified:
felix/trunk/scrplugin/src/main/java/org/apache/felix/scrplugin/tags/JavaClassDescription.java
URL:
http://svn.apache.org/viewvc/felix/trunk/scrplugin/src/main/java/org/apache/felix/scrplugin/tags/JavaClassDescription.java?rev=601722&r1=601721&r2=601722&view=diff
==============================================================================
---
felix/trunk/scrplugin/src/main/java/org/apache/felix/scrplugin/tags/JavaClassDescription.java
(original)
+++
felix/trunk/scrplugin/src/main/java/org/apache/felix/scrplugin/tags/JavaClassDescription.java
Thu Dec 6 04:48:09 2007
@@ -46,14 +46,15 @@
/**
* Get the description for the parent class.
- * @return
+ * @return The description or <code>null</code> if this class is the
+ * Object class.
* @throws MojoExecutionException
*/
JavaClassDescription getSuperClass() throws MojoExecutionException;
/**
* Get the name of the described class.
- * @return
+ * @return The name of the described class.
*/
String getName();
@@ -65,7 +66,7 @@
* Search for a method with the given signature.
* @param name
* @param parameters
- * @return
+ * @return A descriptor for the method or <code>null</code>
* @throws MojoExecutionException
*/
JavaMethod getMethodBySignature(String name, String[] parameters)
@@ -73,19 +74,19 @@
/**
* Is this class public?
- * @return
+ * @return True if this class is public.
*/
boolean isPublic();
/**
* Is this class abstract?
- * @return
+ * @return True if this class is abstract.
*/
boolean isAbstract();
/**
* Is this class an interface?
- * @return
+ * @return True if this is an interface.
*/
boolean isInterface();
@@ -94,7 +95,7 @@
/**
* Is this class of the type?
* @param type
- * @return
+ * @return True if this class is of the type.
* @throws MojoExecutionException
*/
boolean isA(String type) throws MojoExecutionException;
Modified:
felix/trunk/scrplugin/src/main/java/org/apache/felix/scrplugin/tags/JavaClassDescriptorManager.java
URL:
http://svn.apache.org/viewvc/felix/trunk/scrplugin/src/main/java/org/apache/felix/scrplugin/tags/JavaClassDescriptorManager.java?rev=601722&r1=601721&r2=601722&view=diff
==============================================================================
---
felix/trunk/scrplugin/src/main/java/org/apache/felix/scrplugin/tags/JavaClassDescriptorManager.java
(original)
+++
felix/trunk/scrplugin/src/main/java/org/apache/felix/scrplugin/tags/JavaClassDescriptorManager.java
Thu Dec 6 04:48:09 2007
@@ -271,7 +271,7 @@
/**
* Return all source descriptions of this project.
- * @return
+ * @return All contained java class descriptions.
*/
public JavaClassDescription[] getSourceDescriptions() {
final JavaClassDescription[] descs = new
JavaClassDescription[this.sources.length];
@@ -284,7 +284,7 @@
/**
* Get a java class description for the class.
* @param className
- * @return
+ * @return The java class description.
* @throws MojoExecutionException
*/
public JavaClassDescription getJavaClassDescription(String className)
@@ -309,9 +309,7 @@
throw new MojoExecutionException("Unable to load class " +
className);
}
}
- if ( result != null ) {
- this.javaClassDescriptions.put(className, result);
- }
+ this.javaClassDescriptions.put(className, result);
}
return result;
}