javadoc: add some javadocs for classes related to PluginId

This commit is contained in:
nik
2019-04-03 12:09:50 +03:00
parent 52c9fbbf3a
commit 111ac342a6
3 changed files with 8 additions and 3 deletions
@@ -13,7 +13,8 @@ import java.util.Date;
import java.util.List;
/**
* @author max
* Describes a plugin which may be installed into IntelliJ-based IDE. Use {@link com.intellij.ide.plugins.PluginManager#getPlugin(PluginId)}
* to get a descriptor by a plugin ID and {@link com.intellij.ide.plugins.PluginManagerCore#getPlugins()} to get all plugins.
*/
public interface IdeaPluginDescriptor extends PluginDescriptor {
File getPath();
@@ -121,7 +121,11 @@ public class PluginManagerCore {
private static final List<Runnable> ourDisabledPluginsListeners = new CopyOnWriteArrayList<>();
/**
* do not call this method during bootstrap, should be called in a copy of PluginManager, loaded by IdeaClassLoader
* Returns list of all available plugin descriptors (bundled and custom, include disabled ones). Use {@link #getLoadedPlugins(StartupProgress)}
* if you need to get loaded plugins only.
*
* <p>
* Do not call this method during bootstrap, should be called in a copy of PluginManager, loaded by PluginClassLoader.
*/
@NotNull
public static IdeaPluginDescriptor[] getPlugins() {
@@ -23,7 +23,7 @@ import org.jetbrains.annotations.Nullable;
import java.util.Map;
/**
* @author max
* Represents an ID of a plugin. A full descriptor of the plugin may be obtained via {@link com.intellij.ide.plugins.PluginManager#getPlugin(PluginId)} method.
*/
public class PluginId implements Comparable<PluginId> {
public static final PluginId[] EMPTY_ARRAY = new PluginId[0];