Fix FELIX-4151 - Fix mistakes in the javadoc tags
git-svn-id: https://svn.apache.org/repos/asf/felix/trunk@1516444 13f79535-47bb-0310-9956-ffa450edef68
diff --git a/ipojo/runtime/composite/src/main/java/org/apache/felix/ipojo/composite/service/instantiator/ServiceDependencyHandler.java b/ipojo/runtime/composite/src/main/java/org/apache/felix/ipojo/composite/service/instantiator/ServiceDependencyHandler.java
index f06201b..5712080 100644
--- a/ipojo/runtime/composite/src/main/java/org/apache/felix/ipojo/composite/service/instantiator/ServiceDependencyHandler.java
+++ b/ipojo/runtime/composite/src/main/java/org/apache/felix/ipojo/composite/service/instantiator/ServiceDependencyHandler.java
@@ -230,7 +230,7 @@
* @param metadata : the metadata of the component
* @param conf : the instance configuration
* @throws ConfigurationException : the specification attribute is missing
- * @see org.apache.felix.ipojo.CompositeHandler#configure(org.apache.felix.ipojo.CompositeManager, org.apache.felix.ipojo.metadata.Element, java.util.Dictionary)
+ * @see CompositeHandler#configure(org.apache.felix.ipojo.metadata.Element, java.util.Dictionary)
*/
public void configure(Element metadata, Dictionary conf) throws ConfigurationException {
Element[] services = metadata.getElements("subservice");
@@ -259,7 +259,7 @@
/**
* Start the service instantiator handler.
* Start all created service instance.
- * @see org.apache.felix.ipojo.CompositeHandler#start()
+ * @see org.apache.felix.ipojo.composite.CompositeHandler#start()
*/
public void start() {
for (int i = 0; m_sources != null && i < m_sources.size(); i++) {
@@ -283,7 +283,7 @@
/**
* Check the handler validity.
- * @see org.apache.felix.ipojo.CompositeHandler#isValid()
+ * @see org.apache.felix.ipojo.composite.CompositeHandler#isValid()
*/
private void isHandlerValid() {
for (int i = 0; i < m_importers.size(); i++) {
@@ -308,7 +308,7 @@
/**
* Handler stop method.
* Stop all created service instance.
- * @see org.apache.felix.ipojo.CompositeHandler#stop()
+ * @see org.apache.felix.ipojo.composite.CompositeHandler#stop()
*/
public void stop() {
for (int i = 0; m_sources != null && i < m_sources.size(); i++) {
@@ -377,7 +377,7 @@
/**
* Get the service instantiator handler description.
* @return the description
- * @see org.apache.felix.ipojo.CompositeHandler#getDescription()
+ * @see org.apache.felix.ipojo.composite.CompositeHandler#getDescription()
*/
public HandlerDescription getDescription() {
return m_description;
diff --git a/ipojo/runtime/composite/src/main/java/org/apache/felix/ipojo/composite/service/instantiator/ServiceImporter.java b/ipojo/runtime/composite/src/main/java/org/apache/felix/ipojo/composite/service/instantiator/ServiceImporter.java
index ed63da7..36ac5a9 100644
--- a/ipojo/runtime/composite/src/main/java/org/apache/felix/ipojo/composite/service/instantiator/ServiceImporter.java
+++ b/ipojo/runtime/composite/src/main/java/org/apache/felix/ipojo/composite/service/instantiator/ServiceImporter.java
@@ -250,8 +250,7 @@
/**
* Set that this dependency is a service level dependency.
- * This forces the scoping policy to be STRICT.
- * @param b
+ * This forces the scoping policy to be STRICT.
*/
public void setServiceLevelDependency() {
m_specLevelReq = true;
diff --git a/ipojo/runtime/composite/src/main/java/org/apache/felix/ipojo/composite/service/provides/ProvidedServiceHandler.java b/ipojo/runtime/composite/src/main/java/org/apache/felix/ipojo/composite/service/provides/ProvidedServiceHandler.java
index 748fdf5..fa47217 100644
--- a/ipojo/runtime/composite/src/main/java/org/apache/felix/ipojo/composite/service/provides/ProvidedServiceHandler.java
+++ b/ipojo/runtime/composite/src/main/java/org/apache/felix/ipojo/composite/service/provides/ProvidedServiceHandler.java
@@ -125,7 +125,7 @@
* @param metadata : the metadata of the component
* @param configuration : the instance configuration
* @throws ConfigurationException : the exporter cannot be created
- * @see org.apache.felix.ipojo.CompositeHandler#configure(org.apache.felix.ipojo.CompositeManager, org.apache.felix.ipojo.metadata.Element, java.util.Dictionary)
+ * @see CompositeHandler#configure(org.apache.felix.ipojo.metadata.Element, java.util.Dictionary)
*/
public void configure(Element metadata, Dictionary configuration) throws ConfigurationException {
m_context = getCompositeManager().getContext();
@@ -177,7 +177,7 @@
/**
* Start method.
* Start all managed provided service.
- * @see org.apache.felix.ipojo.CompositeHandler#start()
+ * @see org.apache.felix.ipojo.composite.CompositeHandler#start()
*/
public void start() {
// Compute imports and instances
@@ -207,7 +207,7 @@
/**
* Stop method.
* Stop all managed provided service.
- * @see org.apache.felix.ipojo.CompositeHandler#stop()
+ * @see org.apache.felix.ipojo.composite.CompositeHandler#stop()
*/
public void stop() {
for (int i = 0; i < m_managedServices.size(); i++) {
@@ -223,7 +223,7 @@
/**
* Check the handler validity.
- * @see org.apache.felix.ipojo.CompositeHandler#isValid()
+ * @see org.apache.felix.ipojo.composite.CompositeHandler#isValid()
*/
private void isHandlerValid() {
for (int i = 0; i < m_exporters.size(); i++) {
@@ -240,7 +240,7 @@
/**
* Handler state changed.
* @param state : the new instance state.
- * @see org.apache.felix.ipojo.CompositeHandler#stateChanged(int)
+ * @see CompositeHandler#stateChanged(int)
*/
public void stateChanged(int state) {
if (state == ComponentInstance.INVALID) {
diff --git a/ipojo/runtime/core-it/ipojo-core-service-dependency-test/src/main/java/org/apache/felix/ipojo/runtime/core/test/components/error/NullPointerExceptionBinder.java b/ipojo/runtime/core-it/ipojo-core-service-dependency-test/src/main/java/org/apache/felix/ipojo/runtime/core/test/components/error/NullPointerExceptionBinder.java
index 3aca79d..5dfe865 100644
--- a/ipojo/runtime/core-it/ipojo-core-service-dependency-test/src/main/java/org/apache/felix/ipojo/runtime/core/test/components/error/NullPointerExceptionBinder.java
+++ b/ipojo/runtime/core-it/ipojo-core-service-dependency-test/src/main/java/org/apache/felix/ipojo/runtime/core/test/components/error/NullPointerExceptionBinder.java
@@ -24,7 +24,6 @@
@Component(immediate=true)
-@Instantiate
/**
* Throws an NPE when binding a service.
*/
diff --git a/ipojo/runtime/core/src/main/java/org/apache/felix/ipojo/ComponentFactory.java b/ipojo/runtime/core/src/main/java/org/apache/felix/ipojo/ComponentFactory.java
index 8aff8c5..0383ce3 100644
--- a/ipojo/runtime/core/src/main/java/org/apache/felix/ipojo/ComponentFactory.java
+++ b/ipojo/runtime/core/src/main/java/org/apache/felix/ipojo/ComponentFactory.java
@@ -38,11 +38,12 @@
/**
* The component factory manages component instance objects. This management
* consists to create and manage component instances build with the current
- * component factory. If the factory is public a {@see Factory} service is exposed.
+ * component factory. If the factory is public a {@link Factory} service is exposed.
*
* @author <a href="mailto:dev@felix.apache.org">Felix Project Team</a>
- * @see IPojoFactory
- * @see TrackerCustomizer
+ * @see org.apache.felix.ipojo.Factory
+ * @see org.apache.felix.ipojo.IPojoFactory
+ * @see org.apache.felix.ipojo.util.TrackerCustomizer
*/
public class ComponentFactory extends IPojoFactory implements TrackerCustomizer {
diff --git a/ipojo/runtime/core/src/main/java/org/apache/felix/ipojo/ConstructorInjector.java b/ipojo/runtime/core/src/main/java/org/apache/felix/ipojo/ConstructorInjector.java
index dffd3bc..0e27735 100644
--- a/ipojo/runtime/core/src/main/java/org/apache/felix/ipojo/ConstructorInjector.java
+++ b/ipojo/runtime/core/src/main/java/org/apache/felix/ipojo/ConstructorInjector.java
@@ -32,22 +32,22 @@
*/
public interface ConstructorInjector {
- /**
- * Gets the type of the object to inject in the constructor parameter.
- * This is the type looked into the Pojo class, so it must match.
- * Returning <code>null</code> will try to get the class from the
- * injected object, however this can be wrong (implementation instead of interface,
- * boxed objects...) and error-prone.
- * @param index the parameter index
- * @return the Class object (must fit for primitive type)
- */
+ /**
+ * Gets the object to inject in the constructor parameter.
+ * @param index the parameter index
+ * @return the object to be injected.
+ */
Object getConstructorParameter(int index);
- /**
- * Gets the type of the object to
- * @param index
- * @return
- */
+ /**
+ * Gets the type of the object to inject in the constructor parameter.
+ * This is the type looked into the Pojo class, so it must match.
+ * Returning <code>null</code> will try to get the class from the
+ * injected object, however this can be wrong (implementation instead of interface,
+ * boxed objects...) and error-prone.
+ * @param index the parameter index
+ * @return the Class object (must fit also for primitive type)
+ */
Class getConstructorParameterType(int index);
}
diff --git a/ipojo/runtime/core/src/main/java/org/apache/felix/ipojo/EventDispatcher.java b/ipojo/runtime/core/src/main/java/org/apache/felix/ipojo/EventDispatcher.java
index 8219422..0733d7b 100644
--- a/ipojo/runtime/core/src/main/java/org/apache/felix/ipojo/EventDispatcher.java
+++ b/ipojo/runtime/core/src/main/java/org/apache/felix/ipojo/EventDispatcher.java
@@ -34,8 +34,8 @@
* iPOJO Internal event dispatcher.
* This class provides an internal service event dispatcher in order to tackle the
* event storm that can happen when starting large-scale applications.
- * @see Extender
* @author <a href="mailto:dev@felix.apache.org">Felix Project Team</a>
+ * @see org.osgi.framework.ServiceListener
*/
public final class EventDispatcher implements ServiceListener {
diff --git a/ipojo/runtime/core/src/main/java/org/apache/felix/ipojo/IPojoFactory.java b/ipojo/runtime/core/src/main/java/org/apache/felix/ipojo/IPojoFactory.java
index 3f5ee5c..2faa29e 100644
--- a/ipojo/runtime/core/src/main/java/org/apache/felix/ipojo/IPojoFactory.java
+++ b/ipojo/runtime/core/src/main/java/org/apache/felix/ipojo/IPojoFactory.java
@@ -240,7 +240,7 @@
* Creates an instance in the specified service context.
* This method is synchronized to assert the validity of the factory during the creation.
* Callbacks to sub-class and created instances need to be aware that they are holding the monitor lock.
- * This method call the override {@link IPojoFactory#createInstance(Dictionary, IPojoContext, HandlerManager[])
+ * This method call the override {@link IPojoFactory#createInstance(Dictionary, IPojoContext, HandlerManager[])}
* method.
* @param configuration the configuration of the created instance.
* @param serviceContext the service context to push for this instance.
diff --git a/ipojo/runtime/core/src/main/java/org/apache/felix/ipojo/PolicyServiceContext.java b/ipojo/runtime/core/src/main/java/org/apache/felix/ipojo/PolicyServiceContext.java
index fd0bbb2..1f23af8 100644
--- a/ipojo/runtime/core/src/main/java/org/apache/felix/ipojo/PolicyServiceContext.java
+++ b/ipojo/runtime/core/src/main/java/org/apache/felix/ipojo/PolicyServiceContext.java
@@ -485,13 +485,13 @@
/**
* Registers a service.
* Operation not supported.
- * @param sClass
- * @param s
- * @param stringDictionary
- * @param <S>
- * @return
+ * @param clazz the class object
+ * @param svc the service object
+ * @param properties the properties
+ * @param <S> the type of service
+ * @return the service registration
*/
- public <S> ServiceRegistration<S> registerService(Class<S> sClass, S s, Dictionary<String, ?> stringDictionary) {
+ public <S> ServiceRegistration<S> registerService(Class<S> clazz, S svc, Dictionary<String, ?> properties) {
throw new UnsupportedOperationException("PolicyServiceContext can only be used for service dependency and not to provide services");
}
diff --git a/ipojo/runtime/core/src/main/java/org/apache/felix/ipojo/PrimitiveHandler.java b/ipojo/runtime/core/src/main/java/org/apache/felix/ipojo/PrimitiveHandler.java
index 32ef4ad..b45a689 100644
--- a/ipojo/runtime/core/src/main/java/org/apache/felix/ipojo/PrimitiveHandler.java
+++ b/ipojo/runtime/core/src/main/java/org/apache/felix/ipojo/PrimitiveHandler.java
@@ -193,7 +193,7 @@
* @param pojo the pojo on which the method is called.
* @param method the method invoked.
* @param args the arguments array.
- * @see MethodInterceptor#onEntry(Object, Method, Object[])
+ * @see MethodInterceptor#onEntry(Object, java.lang.reflect.Member, Object[])
*/
public void onEntry(Object pojo, Member method, Object[] args) {
// Nothing to do in the default implementation
@@ -209,7 +209,7 @@
* @param pojo the pojo on which the method exits.
* @param method the exiting method.
* @param returnedObj the returned object (boxed for primitive type)
- * @see MethodInterceptor#onExit(Object, Method, Object)
+ * @see MethodInterceptor#onExit(Object, java.lang.reflect.Member, Object)
*/
public void onExit(Object pojo, Member method, Object returnedObj) {
// Nothing to do in the default implementation
@@ -223,7 +223,7 @@
* @param pojo the pojo on which the method was accessed.
* @param method the invoked method.
* @param throwable the thrown exception
- * @see org.apache.felix.ipojo.MethodInterceptor#onError(java.lang.Object, java.lang.reflect.Method, java.lang.Throwable)
+ * @see org.apache.felix.ipojo.MethodInterceptor#onError(Object, java.lang.reflect.Member, Throwable)
*/
public void onError(Object pojo, Member method, Throwable throwable) {
// Nothing to do in the default implementation
@@ -231,10 +231,9 @@
/**
* Callback method called when the execution of a method will terminate :
- * just before to throw an exception or before to return.
- * {@link MethodInterceptor#onExit(Object, Method, Object)} or
- * {@link MethodInterceptor#onError(Object, Method, Throwable)}
- * were already called.
+ * just before to throw an exception or before to return. This callback is called after
+ * {@link MethodInterceptor#onExit(Object, java.lang.reflect.Member, Object)} and
+ * {@link MethodInterceptor#onError(Object, java.lang.reflect.Member, Throwable)}
* This default implementation does nothing.
* @param pojo the pojo on which the method was accessed.
* @param method the invoked method.
diff --git a/ipojo/runtime/core/src/main/java/org/apache/felix/ipojo/context/StringMap.java b/ipojo/runtime/core/src/main/java/org/apache/felix/ipojo/context/StringMap.java
index 737c95b..c189f38 100644
--- a/ipojo/runtime/core/src/main/java/org/apache/felix/ipojo/context/StringMap.java
+++ b/ipojo/runtime/core/src/main/java/org/apache/felix/ipojo/context/StringMap.java
@@ -70,7 +70,7 @@
* @param key : key
* @param value : value
* @return an object.
- * @see java.util.TreeMap#put(K, V)
+ * @see java.util.TreeMap#put(Object, Object)
*/
public Object put(Object key, Object value) {
return super.put(key.toString(), value);
@@ -118,7 +118,7 @@
* @param object1 : first object to compare
* @param object2 : second object to compare
* @return the comparison result
- * @see java.util.Comparator#compare(T, T)
+ * @see java.util.Comparator#compare(Object, Object)
*/
public int compare(Object object1, Object object2) {
if (m_isCaseSensitive) {
diff --git a/ipojo/runtime/core/src/main/java/org/apache/felix/ipojo/dependency/interceptors/DependencyInterceptor.java b/ipojo/runtime/core/src/main/java/org/apache/felix/ipojo/dependency/interceptors/DependencyInterceptor.java
index 2e20546..5c5c696 100644
--- a/ipojo/runtime/core/src/main/java/org/apache/felix/ipojo/dependency/interceptors/DependencyInterceptor.java
+++ b/ipojo/runtime/core/src/main/java/org/apache/felix/ipojo/dependency/interceptors/DependencyInterceptor.java
@@ -26,9 +26,9 @@
*
* Interceptors publishes a service property (target) to select the dependencies they handle.
*
- * Notice that interceptor can invalidate the set of service used by a dependency by calling {@link org.apache.felix
- * .ipojo.util.DependencyModel#invalidateMatchingServices()} and {@link org.apache.felix.ipojo.util
- * .DependencyModel#invalidateSelectedServices()}.
+ * Notice that interceptor can invalidate the set of service used by a dependency by calling
+ * {@link org.apache.felix.ipojo.util.DependencyModel#invalidateMatchingServices()} and
+ * {@link org.apache.felix.ipojo.util.DependencyModel#invalidateSelectedServices()}.
*/
public interface DependencyInterceptor {
diff --git a/ipojo/runtime/core/src/main/java/org/apache/felix/ipojo/handlers/dependency/ServiceCollection.java b/ipojo/runtime/core/src/main/java/org/apache/felix/ipojo/handlers/dependency/ServiceCollection.java
index 0bbebcc..369ad94 100644
--- a/ipojo/runtime/core/src/main/java/org/apache/felix/ipojo/handlers/dependency/ServiceCollection.java
+++ b/ipojo/runtime/core/src/main/java/org/apache/felix/ipojo/handlers/dependency/ServiceCollection.java
@@ -295,7 +295,7 @@
* @param arg0 an index
* @param arg1 an object
* @return N/A
- * @see java.util.List#set(int, E)
+ * @see java.util.List#set(int, Object)
*/
public Object set(int arg0, Object arg1) {
throw new UnsupportedOperationException("Cannot add elements inside this collection");
@@ -363,7 +363,7 @@
/**
* Unsupported operation.
* @param obj an object
- * @see java.util.ListIterator#add(E)
+ * @see java.util.ListIterator#add(Object)
*/
public void add(Object obj) {
throw new UnsupportedOperationException();
@@ -411,7 +411,7 @@
/**
* Unsupported operation.
* @param obj an object
- * @see java.util.ListIterator#set(E)
+ * @see java.util.ListIterator#set(Object)
*/
public void set(Object obj) {
throw new UnsupportedOperationException();
diff --git a/ipojo/runtime/core/src/main/java/org/apache/felix/ipojo/handlers/lifecycle/callback/LifecycleCallbackHandler.java b/ipojo/runtime/core/src/main/java/org/apache/felix/ipojo/handlers/lifecycle/callback/LifecycleCallbackHandler.java
index 62580f8..f495eb4 100644
--- a/ipojo/runtime/core/src/main/java/org/apache/felix/ipojo/handlers/lifecycle/callback/LifecycleCallbackHandler.java
+++ b/ipojo/runtime/core/src/main/java/org/apache/felix/ipojo/handlers/lifecycle/callback/LifecycleCallbackHandler.java
@@ -77,7 +77,7 @@
* @param metadata : the component type metadata
* @param configuration : the instance configuration
* @throws ConfigurationException : one callback metadata is not correct (either the transition or the method are not correct).
- * @see org.apache.felix.ipojo.Handler#configure(org.apache.felix.ipojo.InstanceManager, org.apache.felix.ipojo.metadata.Element, java.util.Dictionary)
+ * @see org.apache.felix.ipojo.Handler#configure(org.apache.felix.ipojo.metadata.Element, java.util.Dictionary)
*/
public void configure(Element metadata, Dictionary configuration) throws ConfigurationException {
m_callbacks = new LifecycleCallback[0];
diff --git a/ipojo/runtime/core/src/main/java/org/apache/felix/ipojo/handlers/lifecycle/controller/ControllerHandler.java b/ipojo/runtime/core/src/main/java/org/apache/felix/ipojo/handlers/lifecycle/controller/ControllerHandler.java
index 08bdbe2..a8aa759 100644
--- a/ipojo/runtime/core/src/main/java/org/apache/felix/ipojo/handlers/lifecycle/controller/ControllerHandler.java
+++ b/ipojo/runtime/core/src/main/java/org/apache/felix/ipojo/handlers/lifecycle/controller/ControllerHandler.java
@@ -51,7 +51,7 @@
* @param metadata : metadata
* @param configuration : configuration
* @throws ConfigurationException : the field attribute is missing or does not exist in the class.
- * @see org.apache.felix.ipojo.Handler#configure(org.apache.felix.ipojo.InstanceManager, org.apache.felix.ipojo.metadata.Element, java.util.Dictionary)
+ * @see org.apache.felix.ipojo.Handler#configure(org.apache.felix.ipojo.metadata.Element, java.util.Dictionary)
*/
public void configure(Element metadata, Dictionary configuration) throws ConfigurationException {
Element[] controller = metadata.getElements("controller");
diff --git a/ipojo/runtime/core/src/main/java/org/apache/felix/ipojo/util/Callback.java b/ipojo/runtime/core/src/main/java/org/apache/felix/ipojo/util/Callback.java
index fe32379..826f663 100644
--- a/ipojo/runtime/core/src/main/java/org/apache/felix/ipojo/util/Callback.java
+++ b/ipojo/runtime/core/src/main/java/org/apache/felix/ipojo/util/Callback.java
@@ -67,7 +67,7 @@
/**
* Creates a Callback.
* If the argument array is not null the reflection type are computed.
- * @see {@link Callback#computeArguments(String[])}
+ * @see Callback#computeArguments(String[])
* @param method the name of the method to call
* @param args the argument type name, or <code>null</code> if no arguments
* @param isStatic is the method a static method
@@ -104,7 +104,7 @@
/**
* Creates a Callback.
* @param method the {@link MethodMetadata} obtained from manipulation
- * metadata ({@link PojoMetadata}).
+ * metadata ({@link org.apache.felix.ipojo.parser.PojoMetadata}).
* @param manager the instance manager.
*/
public Callback(MethodMetadata method, InstanceManager manager) {