You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@karaf.apache.org by jb...@apache.org on 2019/06/12 13:27:17 UTC
[karaf] 02/02: Fix javadoc generation
This is an automated email from the ASF dual-hosted git repository.
jbonofre pushed a commit to branch karaf-4.2.x
in repository https://gitbox.apache.org/repos/asf/karaf.git
commit e95c5cd2f6a070e81c81639268f6108d7acf8b49
Author: Jean-Baptiste Onofré <jb...@apache.org>
AuthorDate: Wed Jun 12 10:48:40 2019 +0200
Fix javadoc generation
---
main/src/main/java/org/apache/karaf/main/Main.java | 32 +++++++++++-----------
.../felix/eventadmin/impl/Configuration.java | 18 ++++++------
.../impl/adapter/BundleEventAdapter.java | 6 ++--
.../eventadmin/impl/handler/EventAdminImpl.java | 14 +++++-----
.../apache/karaf/util/config/PropertiesLoader.java | 16 +++++------
5 files changed, 43 insertions(+), 43 deletions(-)
diff --git a/main/src/main/java/org/apache/karaf/main/Main.java b/main/src/main/java/org/apache/karaf/main/Main.java
index e8c9f69..69ca910 100644
--- a/main/src/main/java/org/apache/karaf/main/Main.java
+++ b/main/src/main/java/org/apache/karaf/main/Main.java
@@ -99,18 +99,18 @@ public class Main {
* </p>
* <ol>
* <li><i><b>Read the system properties file.</b></i> This is a file
- * containing properties to be pushed into <tt>System.setProperty()</tt>
+ * containing properties to be pushed into <code>System.setProperty()</code>
* before starting the framework. This mechanism is mainly shorthand
* for people starting the framework from the command line to avoid having
- * to specify a bunch of <tt>-D</tt> system property definitions.
+ * to specify a bunch of <code>-D</code> system property definitions.
* The only properties defined in this file that will impact the framework's
* behavior are the those concerning setting HTTP proxies, such as
- * <tt>http.proxyHost</tt>, <tt>http.proxyPort</tt>, and
- * <tt>http.proxyAuth</tt>.
+ * <code>http.proxyHost</code>, <code>http.proxyPort</code>, and
+ * <code>http.proxyAuth</code>.
* </li>
* <li><i><b>Perform system property variable substitution on system
* properties.</b></i> Any system properties in the system property
- * file whose value adheres to <tt>${<system-prop-name>}</tt>
+ * file whose value adheres to <code>${<system-prop-name>}</code>
* syntax will have their value substituted with the appropriate
* system property value.
* </li>
@@ -118,35 +118,35 @@ public class Main {
* a file containing properties used to configure the framework
* instance and to pass configuration information into
* bundles installed into the framework instance. The configuration
- * property file is called <tt>config.properties</tt> by default
- * and is located in the <tt>conf/</tt> directory of the Felix
+ * property file is called <code>config.properties</code> by default
+ * and is located in the <code>conf/</code> directory of the Felix
* installation directory, which is the parent directory of the
- * directory containing the <tt>felix.jar</tt> file. It is possible
+ * directory containing the <code>felix.jar</code> file. It is possible
* to use a different location for the property file by specifying
- * the desired URL using the <tt>felix.config.properties</tt>
- * system property; this should be set using the <tt>-D</tt> syntax
+ * the desired URL using the <code>felix.config.properties</code>
+ * system property; this should be set using the <code>-D</code> syntax
* when executing the JVM. Refer to the
- * <tt>Felix</tt> constructor documentation for more
+ * <code>Felix</code> constructor documentation for more
* information on the framework configuration options.
* </li>
* <li><i><b>Perform system property variable substitution on configuration
* properties.</b></i> Any configuration properties whose value adheres to
- * <tt>${<system-prop-name>}</tt> syntax will have their value
+ * <code>${<system-prop-name>}</code> syntax will have their value
* substituted with the appropriate system property value.
* </li>
* <li><i><b>Ensure the default bundle cache has sufficient information to
* initialize.</b></i> The default implementation of the bundle cache
* requires either a profile name or a profile directory in order to
* start. The configuration properties are checked for at least one
- * of the <tt>felix.cache.profile</tt> or <tt>felix.cache.profiledir</tt>
+ * of the <code>felix.cache.profile</code> or <code>felix.cache.profiledir</code>
* properties. If neither is found, the user is asked to supply a profile
* name that is added to the configuration property set. See the
- * <a href="cache/DefaultBundleCache.html"><tt>DefaultBundleCache</tt></a>
+ * <a href="cache/DefaultBundleCache.html"><code>DefaultBundleCache</code></a>
* documentation for more details its configuration options.
* </li>
* <li><i><b>Creates and starts a framework instance.</b></i> A
* case insensitive
- * <a href="util/StringMap.html"><tt>StringMap</tt></a>
+ * <a href="util/StringMap.html"><code>StringMap</code></a>
* is created for the configuration property file and is passed
* into the framework.
* </li>
@@ -160,7 +160,7 @@ public class Main {
* the configuration property file cannot be found, the framework will appear to
* be hung or deadlocked. This is not the case, it is executing correctly,
* there is just no way to interact with it. Refer to the
- * <tt>Felix</tt> constructor documentation for more information on
+ * <code>Felix</code> constructor documentation for more information on
* framework configuration options.
* </p>
* @param args An array of arguments, all of which are ignored.
diff --git a/services/eventadmin/src/main/java/org/apache/felix/eventadmin/impl/Configuration.java b/services/eventadmin/src/main/java/org/apache/felix/eventadmin/impl/Configuration.java
index 2bf1d6a..0590719 100644
--- a/services/eventadmin/src/main/java/org/apache/felix/eventadmin/impl/Configuration.java
+++ b/services/eventadmin/src/main/java/org/apache/felix/eventadmin/impl/Configuration.java
@@ -44,38 +44,38 @@ import org.osgi.service.metatype.MetaTypeProvider;
*
* <p>The service knows about the following properties which are read at bundle startup:</p>
* <p>
- * <tt>org.apache.felix.eventadmin.ThreadPoolSize</tt> - The size of the thread
+ * <code>org.apache.felix.eventadmin.ThreadPoolSize</code> - The size of the thread
* pool.
* </p>
*
* <p>The default value is 10. Increase in case of a large amount of synchronous events
- * where the <tt>EventHandler</tt> services in turn send new synchronous events in
+ * where the <code>EventHandler</code> services in turn send new synchronous events in
* the event dispatching thread or a lot of timeouts are to be expected. A value of
* less then 2 triggers the default value. A value of 2 effectively disables thread
* pooling.</p>
*
* <p>
- * <tt>org.apache.felix.eventadmin.Timeout</tt> - The black-listing timeout in
+ * <code>org.apache.felix.eventadmin.Timeout</code> - The black-listing timeout in
* milliseconds
* </p>
*
* <p>The default value is 5000. Increase or decrease at own discretion. A value of less
* then 100 turns timeouts off. Any other value is the time in milliseconds granted
- * to each <tt>EventHandler</tt> before it gets blacklisted.</p>
+ * to each <code>EventHandler</code> before it gets blacklisted.</p>
*
* <p>
- * <tt>org.apache.felix.eventadmin.RequireTopic</tt> - Are <tt>EventHandler</tt>
+ * <code>org.apache.felix.eventadmin.RequireTopic</code> - Are <code>EventHandler</code>
* required to be registered with a topic?
* </p>
*
- * <p>The default is <tt>true</tt>. The specification says that <tt>EventHandler</tt>
+ * <p>The default is <code>true</code>. The specification says that <code>EventHandler</code>
* must register with a list of topics they are interested in. Setting this value to
- * <tt>false</tt> will enable that handlers without a topic are receiving all events
+ * <code>false</code> will enable that handlers without a topic are receiving all events
* (i.e., they are treated the same as with a topic=*).</p>
*
* <p>
- * <tt>org.apache.felix.eventadmin.IgnoreTimeout</tt> - Configure
- * <tt>EventHandler</tt>s to be called without a timeout.
+ * <code>org.apache.felix.eventadmin.IgnoreTimeout</code> - Configure
+ * <code>EventHandler</code>s to be called without a timeout.
* </p>
*
* <p>If a timeout is configured by default all event handlers are called using the timeout.
diff --git a/services/eventadmin/src/main/java/org/apache/felix/eventadmin/impl/adapter/BundleEventAdapter.java b/services/eventadmin/src/main/java/org/apache/felix/eventadmin/impl/adapter/BundleEventAdapter.java
index d59a1d0..7a98aae 100644
--- a/services/eventadmin/src/main/java/org/apache/felix/eventadmin/impl/adapter/BundleEventAdapter.java
+++ b/services/eventadmin/src/main/java/org/apache/felix/eventadmin/impl/adapter/BundleEventAdapter.java
@@ -39,11 +39,11 @@ public class BundleEventAdapter extends AbstractAdapter implements SynchronousBu
{
/**
* The constructor of the adapter. This will register the adapter with the given
- * context as a <tt>BundleListener</tt> and subsequently, will post received
+ * context as a <code>BundleListener</code> and subsequently, will post received
* events via the given EventAdmin.
*
* @param context The bundle context with which to register as a listener.
- * @param admin The <tt>EventAdmin</tt> to use for posting events.
+ * @param admin The <code>EventAdmin</code> to use for posting events.
*/
public BundleEventAdapter(final BundleContext context, final EventAdmin admin)
{
@@ -58,7 +58,7 @@ public class BundleEventAdapter extends AbstractAdapter implements SynchronousBu
/**
* Once a bundle event is received this method assembles and posts an event via
- * the <tt>EventAdmin</tt> as specified in 113.6.4 OSGi R4 compendium.
+ * the <code>EventAdmin</code> as specified in 113.6.4 OSGi R4 compendium.
*
* @param event The event to adapt.
*/
diff --git a/services/eventadmin/src/main/java/org/apache/felix/eventadmin/impl/handler/EventAdminImpl.java b/services/eventadmin/src/main/java/org/apache/felix/eventadmin/impl/handler/EventAdminImpl.java
index b583b6c..5491865 100644
--- a/services/eventadmin/src/main/java/org/apache/felix/eventadmin/impl/handler/EventAdminImpl.java
+++ b/services/eventadmin/src/main/java/org/apache/felix/eventadmin/impl/handler/EventAdminImpl.java
@@ -34,13 +34,13 @@ import org.osgi.service.event.EventConstants;
/**
* This is the actual implementation of the OSGi R4 Event Admin Service (see the
- * Compendium 113 for details). The implementation uses a <tt>HandlerTasks</tt>
- * in order to determine applicable <tt>EventHandler</tt> for a specific event and
- * subsequently dispatches the event to the handlers via <tt>DeliverTasks</tt>.
- * To do this, it uses two different <tt>DeliverTasks</tt> one for asynchronous and
- * one for synchronous event delivery depending on whether its <tt>post()</tt> or
- * its <tt>send()</tt> method is called. Note that the actual work is done in the
- * implementations of the <tt>DeliverTasks</tt>. Additionally, a stop method is
+ * Compendium 113 for details). The implementation uses a <code>HandlerTasks</code>
+ * in order to determine applicable <code>EventHandler</code> for a specific event and
+ * subsequently dispatches the event to the handlers via <code>DeliverTasks</code>.
+ * To do this, it uses two different <code>DeliverTasks</code> one for asynchronous and
+ * one for synchronous event delivery depending on whether its <code>post()</code> or
+ * its <code>send()</code> method is called. Note that the actual work is done in the
+ * implementations of the <code>DeliverTasks</code>. Additionally, a stop method is
* provided that prevents subsequent events to be delivered.
*
* @author <a href="mailto:dev@felix.apache.org">Felix Project Team</a>
diff --git a/util/src/main/java/org/apache/karaf/util/config/PropertiesLoader.java b/util/src/main/java/org/apache/karaf/util/config/PropertiesLoader.java
index dcb22dc..ab26ba7 100644
--- a/util/src/main/java/org/apache/karaf/util/config/PropertiesLoader.java
+++ b/util/src/main/java/org/apache/karaf/util/config/PropertiesLoader.java
@@ -45,10 +45,10 @@ public class PropertiesLoader {
* associated with the framework installation; these properties
* are accessible to the framework and to bundles and are intended
* for configuration purposes. By default, the configuration property
- * file is located in the <tt>conf/</tt> directory of the Felix
- * installation directory and is called "<tt>config.properties</tt>".
+ * file is located in the <code>conf/</code> directory of the Felix
+ * installation directory and is called "<code>config.properties</code>".
* The installation directory of Felix is assumed to be the parent
- * directory of the <tt>felix.jar</tt> file as found on the system class
+ * directory of the <code>felix.jar</code> file as found on the system class
* path property. The precise file from which to load configuration
* properties can be set by initializing the "<code>felix.config.properties</code>"
* system property to an arbitrary URL.
@@ -86,14 +86,14 @@ public class PropertiesLoader {
/**
* <p>
* Loads the properties in the system property file associated with the
- * framework installation into <tt>System.setProperty()</tt>. These properties
+ * framework installation into <code>System.setProperty()</code>. These properties
* are not directly used by the framework in anyway. By default, the system
- * property file is located in the <tt>conf/</tt> directory of the Felix
- * installation directory and is called "<tt>system.properties</tt>". The
+ * property file is located in the <code>conf/</code> directory of the Felix
+ * installation directory and is called "<code>system.properties</code>". The
* installation directory of Felix is assumed to be the parent directory of
- * the <tt>felix.jar</tt> file as found on the system class path property.
+ * the <code>felix.jar</code> file as found on the system class path property.
* The precise file from which to load system properties can be set by
- * initializing the "<tt>felix.system.properties</tt>" system property to an
+ * initializing the "<code>felix.system.properties</code>" system property to an
* arbitrary URL.
* </p>
*