diff options
| author | Thomas Watson | 2010-02-09 21:43:33 +0000 |
|---|---|---|
| committer | Thomas Watson | 2010-02-09 21:43:33 +0000 |
| commit | 703a46abe74f8a132b568b758c6a2c8490dfcf3f (patch) | |
| tree | 37076c1f5cc2095caef62b26ac0b7e3e5c28d542 /bundles/org.eclipse.osgi | |
| parent | db713726472adcd138fc55bddfab2e69b0efcb7a (diff) | |
| download | rt.equinox.framework-703a46abe74f8a132b568b758c6a2c8490dfcf3f.tar.gz rt.equinox.framework-703a46abe74f8a132b568b758c6a2c8490dfcf3f.tar.xz rt.equinox.framework-703a46abe74f8a132b568b758c6a2c8490dfcf3f.zip | |
Bug 301965 Eclipse OSGi APIs incomplete in isv doc
Diffstat (limited to 'bundles/org.eclipse.osgi')
14 files changed, 205 insertions, 3 deletions
diff --git a/bundles/org.eclipse.osgi/core/adaptor/org/eclipse/osgi/service/resolver/package.html b/bundles/org.eclipse.osgi/core/adaptor/org/eclipse/osgi/service/resolver/package.html new file mode 100644 index 000000000..04babd03f --- /dev/null +++ b/bundles/org.eclipse.osgi/core/adaptor/org/eclipse/osgi/service/resolver/package.html @@ -0,0 +1,17 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html> +<head> + <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> + <title>Package-level Javadoc</title> +</head> +<body> +Provides the Equinox resolver API. +<h2> +Package Specification</h2> +This package specifies the API for Equinox resolver. +<p> +Clients that need access to the Equinox runtime resolver will likely be interested +in the types provided by this package. +</p> +</body> +</html> diff --git a/bundles/org.eclipse.osgi/core/framework/org/eclipse/osgi/framework/console/package.html b/bundles/org.eclipse.osgi/core/framework/org/eclipse/osgi/framework/console/package.html new file mode 100644 index 000000000..d140bf5b7 --- /dev/null +++ b/bundles/org.eclipse.osgi/core/framework/org/eclipse/osgi/framework/console/package.html @@ -0,0 +1,17 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html> +<head> + <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> + <title>Package-level Javadoc</title> +</head> +<body> +Provides services related to the Equinox console. +<h2> +Package Specification</h2> +This package specifies the API for services related to the Equinox console. +<p> +Clients which provide commands or provide sessions to the Equinox console +will likely be interested in the types provided by this package. +</p> +</body> +</html> diff --git a/bundles/org.eclipse.osgi/core/framework/org/eclipse/osgi/framework/eventmgr/package.html b/bundles/org.eclipse.osgi/core/framework/org/eclipse/osgi/framework/eventmgr/package.html new file mode 100644 index 000000000..41e344cab --- /dev/null +++ b/bundles/org.eclipse.osgi/core/framework/org/eclipse/osgi/framework/eventmgr/package.html @@ -0,0 +1,17 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html> +<head> + <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> + <title>Package-level Javadoc</title> +</head> +<body> +Provides the event manager API. +<h2> +Package Specification</h2> +This package specifies the API for the event manager. +<p> +Clients which implement an event bus to deliver synchronous and/or asynchronous +events to listeners will likely be interested in the types provided by this package. +</p> +</body> +</html> diff --git a/bundles/org.eclipse.osgi/core/framework/org/eclipse/osgi/launch/package.html b/bundles/org.eclipse.osgi/core/framework/org/eclipse/osgi/launch/package.html new file mode 100644 index 000000000..b2d671be0 --- /dev/null +++ b/bundles/org.eclipse.osgi/core/framework/org/eclipse/osgi/launch/package.html @@ -0,0 +1,17 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html> +<head> + <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> + <title>Package-level Javadoc</title> +</head> +<body> +Provides the Equinox framework launch API. +<h2> +Package Specification</h2> +This package specifies the Equinox framework launch API. +<p> +Clients that want to launch an embedded instance of Equinox +will likely be interested in the types provided by this package. +</p> +</body> +</html> diff --git a/bundles/org.eclipse.osgi/supplement/src/org/eclipse/osgi/framework/eventmgr/package.html b/bundles/org.eclipse.osgi/supplement/src/org/eclipse/osgi/framework/eventmgr/package.html new file mode 100644 index 000000000..41e344cab --- /dev/null +++ b/bundles/org.eclipse.osgi/supplement/src/org/eclipse/osgi/framework/eventmgr/package.html @@ -0,0 +1,17 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html> +<head> + <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> + <title>Package-level Javadoc</title> +</head> +<body> +Provides the event manager API. +<h2> +Package Specification</h2> +This package specifies the API for the event manager. +<p> +Clients which implement an event bus to deliver synchronous and/or asynchronous +events to listeners will likely be interested in the types provided by this package. +</p> +</body> +</html> diff --git a/bundles/org.eclipse.osgi/supplement/src/org/eclipse/osgi/framework/log/package.html b/bundles/org.eclipse.osgi/supplement/src/org/eclipse/osgi/framework/log/package.html new file mode 100644 index 000000000..a4db43cbc --- /dev/null +++ b/bundles/org.eclipse.osgi/supplement/src/org/eclipse/osgi/framework/log/package.html @@ -0,0 +1,17 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html> +<head> + <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> + <title>Package-level Javadoc</title> +</head> +<body> +Provides the <tt>FrameworkLog</tt> service. +<h2> +Package Specification</h2> +This package specifies the API for the <tt>FrameworkLog</tt> service. +<p> +Clients needing to log entries to the eclipse log will likely be interested +in the types provided by this package. +</p> +</body> +</html> diff --git a/bundles/org.eclipse.osgi/supplement/src/org/eclipse/osgi/service/debug/package.html b/bundles/org.eclipse.osgi/supplement/src/org/eclipse/osgi/service/debug/package.html new file mode 100644 index 000000000..8c32c76e5 --- /dev/null +++ b/bundles/org.eclipse.osgi/supplement/src/org/eclipse/osgi/service/debug/package.html @@ -0,0 +1,17 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html> +<head> + <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> + <title>Package-level Javadoc</title> +</head> +<body> +Provides the <tt>DebugOptions</tt> service. +<h2> +Package Specification</h2> +This package specifies the API for the <tt>DebugOptions</tt> service. +<p> +Clients accessing debug and trace options will likely be interested +in the types provided by this package. +</p> +</body> +</html> diff --git a/bundles/org.eclipse.osgi/supplement/src/org/eclipse/osgi/service/environment/package.html b/bundles/org.eclipse.osgi/supplement/src/org/eclipse/osgi/service/environment/package.html new file mode 100644 index 000000000..ef6f90466 --- /dev/null +++ b/bundles/org.eclipse.osgi/supplement/src/org/eclipse/osgi/service/environment/package.html @@ -0,0 +1,18 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html> +<head> + <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> + <title>Package-level Javadoc</title> +</head> +<body> +Provides the <tt>EnvironmentInfo</tt> service. +<h2> +Package Specification</h2> +This package specifies the API for the <tt>EnvironmentInfo</tt> service. +<p> +Clients accessing the command line used to start the running framework +as well as information about the environment will likely be interested +in the types provided by this package. +</p> +</body> +</html> diff --git a/bundles/org.eclipse.osgi/supplement/src/org/eclipse/osgi/service/localization/package.html b/bundles/org.eclipse.osgi/supplement/src/org/eclipse/osgi/service/localization/package.html new file mode 100644 index 000000000..07ddb0021 --- /dev/null +++ b/bundles/org.eclipse.osgi/supplement/src/org/eclipse/osgi/service/localization/package.html @@ -0,0 +1,19 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html> +<head> + <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> + <title>Package-level Javadoc</title> +</head> +<body> +Provides bundle localization and local provider service APIs. +<h2> +Package Specification</h2> +This package specifies the API for the <tt>BundleLocalization</tt> and +<tt>LocalePrivder</tt> services. +<p> +Clients accessing the localization resource bundles use to localize +OSGi bundle manifests will likely be interested in the types provided +by this package. +</p> +</body> +</html> diff --git a/bundles/org.eclipse.osgi/supplement/src/org/eclipse/osgi/service/runnable/ApplicationLauncher.java b/bundles/org.eclipse.osgi/supplement/src/org/eclipse/osgi/service/runnable/ApplicationLauncher.java index b1be943d3..85128c99e 100644 --- a/bundles/org.eclipse.osgi/supplement/src/org/eclipse/osgi/service/runnable/ApplicationLauncher.java +++ b/bundles/org.eclipse.osgi/supplement/src/org/eclipse/osgi/service/runnable/ApplicationLauncher.java @@ -1,5 +1,5 @@ /******************************************************************************* - * Copyright (c) 2005, 2008 IBM Corporation and others. + * Copyright (c) 2005, 2010 IBM Corporation and others. * All rights reserved. This program and the accompanying materials * are made available under the terms of the Eclipse Public License v1.0 * which accompanies this distribution, and is available at @@ -17,6 +17,10 @@ package org.eclipse.osgi.service.runnable; * <p> * This interface is not intended to be implemented by clients. * </p> + * <p> + * This class is for internal use by the platform-related plug-ins. + * Clients outside of the base platform should not reference or subclass this class. + * </p> * * @since 3.2 * @noimplement This interface is not intended to be implemented by clients. diff --git a/bundles/org.eclipse.osgi/supplement/src/org/eclipse/osgi/service/runnable/ApplicationRunnable.java b/bundles/org.eclipse.osgi/supplement/src/org/eclipse/osgi/service/runnable/ApplicationRunnable.java index c01f2ec3e..1d9efee1f 100644 --- a/bundles/org.eclipse.osgi/supplement/src/org/eclipse/osgi/service/runnable/ApplicationRunnable.java +++ b/bundles/org.eclipse.osgi/supplement/src/org/eclipse/osgi/service/runnable/ApplicationRunnable.java @@ -1,5 +1,5 @@ /******************************************************************************* - * Copyright (c) 2004, 2008 IBM Corporation and others. + * Copyright (c) 2004, 2010 IBM Corporation and others. * All rights reserved. This program and the accompanying materials * are made available under the terms of the Eclipse Public License v1.0 * which accompanies this distribution, and is available at @@ -12,6 +12,10 @@ package org.eclipse.osgi.service.runnable; /** * A parameterized runnable that can be stopped. + * <p> + * This class is for internal use by the platform-related plug-ins. + * Clients outside of the base platform should not reference or subclass this class. + * </p> * @since 3.2 */ public interface ApplicationRunnable extends ParameterizedRunnable { diff --git a/bundles/org.eclipse.osgi/supplement/src/org/eclipse/osgi/service/runnable/ParameterizedRunnable.java b/bundles/org.eclipse.osgi/supplement/src/org/eclipse/osgi/service/runnable/ParameterizedRunnable.java index 2489dbde5..e75c891f3 100644 --- a/bundles/org.eclipse.osgi/supplement/src/org/eclipse/osgi/service/runnable/ParameterizedRunnable.java +++ b/bundles/org.eclipse.osgi/supplement/src/org/eclipse/osgi/service/runnable/ParameterizedRunnable.java @@ -1,5 +1,5 @@ /******************************************************************************* - * Copyright (c) 2004, 2008 IBM Corporation and others. + * Copyright (c) 2004, 2010 IBM Corporation and others. * All rights reserved. This program and the accompanying materials * are made available under the terms of the Eclipse Public License v1.0 * which accompanies this distribution, and is available at @@ -18,6 +18,10 @@ package org.eclipse.osgi.service.runnable; * <p> * Clients may implement this interface. * </p> + * <p> + * This class is for internal use by the platform-related plug-ins. + * Clients outside of the base platform should not reference or subclass this class. + * </p> * @since 3.0 */ public interface ParameterizedRunnable { diff --git a/bundles/org.eclipse.osgi/supplement/src/org/eclipse/osgi/service/runnable/package.html b/bundles/org.eclipse.osgi/supplement/src/org/eclipse/osgi/service/runnable/package.html new file mode 100644 index 000000000..03dbe8d4a --- /dev/null +++ b/bundles/org.eclipse.osgi/supplement/src/org/eclipse/osgi/service/runnable/package.html @@ -0,0 +1,17 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html> +<head> + <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> + <title>Package-level Javadoc</title> +</head> +<body> +Provides API for monitoring and running code on the main thread. +<h2> +Package Specification</h2> +This package specifies the API for monitoring and running code on the main thread. +<p> +Clients that monitor the startup sequence will likely be interested +in the types provided by this package. +</p> +</body> +</html> diff --git a/bundles/org.eclipse.osgi/supplement/src/org/eclipse/osgi/storagemanager/package.html b/bundles/org.eclipse.osgi/supplement/src/org/eclipse/osgi/storagemanager/package.html new file mode 100644 index 000000000..660775973 --- /dev/null +++ b/bundles/org.eclipse.osgi/supplement/src/org/eclipse/osgi/storagemanager/package.html @@ -0,0 +1,17 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html> +<head> + <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> + <title>Package-level Javadoc</title> +</head> +<body> +Provides the storage manager API. +<h2> +Package Specification</h2> +This package specifies the API for managing a group of files that are related to each other. +<p> +Clients that manage groups of files that are closely related to each other may be interested +in the types provided by this package. +</p> +</body> +</html> |