FELIX-3535 javadoc cleanup
git-svn-id: https://svn.apache.org/repos/asf/felix/trunk@1346205 13f79535-47bb-0310-9956-ffa450edef68
diff --git a/scr/src/main/java/org/apache/felix/scr/impl/config/ConfigurationSupport.java b/scr/src/main/java/org/apache/felix/scr/impl/config/ConfigurationSupport.java
index d60fb52..f90f14e 100644
--- a/scr/src/main/java/org/apache/felix/scr/impl/config/ConfigurationSupport.java
+++ b/scr/src/main/java/org/apache/felix/scr/impl/config/ConfigurationSupport.java
@@ -153,9 +153,9 @@
* This method is really only called upon configuration changes; it is not
* called for existing configurations upon startup of the Configuration
* Admin service. To bridge this gap, the
- * {@link #serviceChanged(ServiceEvent)} method called when the
- * Configuration Admin service is registered calls this method for all
- * existing configurations to be able to foward existing configurations to
+ * {@link ComponentRegistry#serviceChanged(org.osgi.framework.ServiceEvent)} method called when the
+ * Configuration Admin service is registered calls #configureComponentHolders which calls this method for all
+ * existing configurations to be able to forward existing configurations to
* components.
*
* @param event The configuration change event
@@ -231,7 +231,7 @@
}
catch (IllegalStateException ise)
{
- // If the bundle has been stopped conurrently
+ // If the bundle has been stopped concurrently
Activator.log(LogService.LOG_WARNING, null, "Unknown ConfigurationEvent type " + event.getType(),
ise);
}
@@ -272,9 +272,9 @@
* Returns the configuration whose PID equals the given pid. If no such
* configuration exists, <code>null</code> is returned.
*
- * @param ctx
- * @param pid
- * @return
+ * @param ca Configuration Admin service
+ * @param pid Pid for desired configuration
+ * @return configuration with the specified Pid
*/
public Configuration findSingletonConfiguration(final ConfigurationAdmin ca, final String pid)
{
@@ -287,9 +287,9 @@
* Returns all configurations whose factory PID equals the given factory PID
* or <code>null</code> if no such configurations exist
*
- * @param ctx
- * @param factoryPid
- * @return
+ * @param ca ConfigurationAdmin service
+ * @param factoryPid factory Pid we want the configurations for
+ * @return the configurations specifying the supplied factory Pid.
*/
public Configuration[] findFactoryConfigurations(final ConfigurationAdmin ca, final String factoryPid)
{
diff --git a/scr/src/main/java/org/apache/felix/scr/impl/config/ImmediateComponentHolder.java b/scr/src/main/java/org/apache/felix/scr/impl/config/ImmediateComponentHolder.java
index 398d73d..d7a22a2 100644
--- a/scr/src/main/java/org/apache/felix/scr/impl/config/ImmediateComponentHolder.java
+++ b/scr/src/main/java/org/apache/felix/scr/impl/config/ImmediateComponentHolder.java
@@ -96,7 +96,7 @@
/**
* Whether components have already been enabled by calling the
- * {@link #enableComponents()} method. If this field is <code>true</code>
+ * {@link #enableComponents(boolean)} method. If this field is <code>true</code>
* component instances created per configuration by the
* {@link #configurationUpdated(String, Dictionary)} method are also
* enabled. Otherwise they are not enabled immediately.
diff --git a/scr/src/main/java/org/apache/felix/scr/impl/manager/ComponentFactoryImpl.java b/scr/src/main/java/org/apache/felix/scr/impl/manager/ComponentFactoryImpl.java
index 1a7df82..a80b2f0 100644
--- a/scr/src/main/java/org/apache/felix/scr/impl/manager/ComponentFactoryImpl.java
+++ b/scr/src/main/java/org/apache/felix/scr/impl/manager/ComponentFactoryImpl.java
@@ -66,6 +66,7 @@
* <p>
* The map is keyed by the component manager instances. The value of each
* entry is the same as the entry's key.
+ * This is an IdentityHashMap for speed, thus not a Set.
*/
private final Map m_componentInstances;
diff --git a/scr/src/main/java/org/apache/felix/scr/impl/manager/ServiceFactoryComponentManager.java b/scr/src/main/java/org/apache/felix/scr/impl/manager/ServiceFactoryComponentManager.java
index f412b24..df0a417 100644
--- a/scr/src/main/java/org/apache/felix/scr/impl/manager/ServiceFactoryComponentManager.java
+++ b/scr/src/main/java/org/apache/felix/scr/impl/manager/ServiceFactoryComponentManager.java
@@ -34,7 +34,8 @@
/**
- * The <code>ServiceFactoryComponentManager</code> TODO
+ * The <code>ServiceFactoryComponentManager</code> for components specified with <service serviceFactory='true'/>
+ * in the xml metadata. The component must be delayed, not immediate or factory.
*/
public class ServiceFactoryComponentManager extends ImmediateComponentManager implements ServiceFactory
{
@@ -45,8 +46,9 @@
/**
- * @param activator
- * @param metadata
+ * @param activator BundleComponentActivator for this DS implementation
+ * @param componentHolder ComponentHolder for configuration management
+ * @param metadata ComponentMetadata for this component
*/
public ServiceFactoryComponentManager( BundleComponentActivator activator, ComponentHolder componentHolder,
ComponentMetadata metadata )
diff --git a/scr/src/main/java/org/apache/felix/scr/impl/metadata/ComponentMetadata.java b/scr/src/main/java/org/apache/felix/scr/impl/metadata/ComponentMetadata.java
index 2469c9d..e6b28b6 100644
--- a/scr/src/main/java/org/apache/felix/scr/impl/metadata/ComponentMetadata.java
+++ b/scr/src/main/java/org/apache/felix/scr/impl/metadata/ComponentMetadata.java
@@ -820,7 +820,6 @@
}
m_validated = true;
- // TODO: put a similar flag on the references and the services
}