Fixed javadoc

meridor · Jan 30, 2015 · 09e3775 · 09e3775
1 parent b2f43a1
commit 09e3775
Show file tree

Hide file tree

Showing 7 changed files with 9 additions and 7 deletions.
diff --git a/stecker-plugin-loader/src/main/java/org/meridor/stecker/PluginLoader.java b/stecker-plugin-loader/src/main/java/org/meridor/stecker/PluginLoader.java
@@ -53,7 +53,7 @@ private PluginLoader(Path pluginsDirectory) {
      *
      * @param pluginsDirectory directory containing plugins
      * @return this
-     * @throws PluginException
+     * @throws org.meridor.stecker.PluginException when plugins directory is null
      */
     public static PluginLoader withPluginDirectory(Path pluginsDirectory) throws PluginException {
         if (pluginsDirectory == null) {
@@ -265,6 +265,7 @@ public List<Class> getExtensionPoints() {
      * Returns {@link PluginRegistry} storing information about loaded classes
      *
      * @return plugin registry with loaded classes
+     * @throws org.meridor.stecker.PluginException when something goes wrong during plugins loading
      */
     public PluginRegistry load() throws PluginException {
 

diff --git a/stecker-plugin-loader/src/main/java/org/meridor/stecker/PluginMetadata.java b/stecker-plugin-loader/src/main/java/org/meridor/stecker/PluginMetadata.java
@@ -57,7 +57,7 @@ public interface PluginMetadata {
     /**
      * Returns maintainer email and name
      *
-     * @return email and name in the format: <b>John Smith <[email protected]></b> or empty if not set
+     * @return email and name in the format: <b>John Smith &lt;[email protected]&gt;</b> or empty if not set
      */
     Optional<String> getMaintainer();
 

diff --git a/stecker-plugin-loader/src/main/java/org/meridor/stecker/interfaces/ClassesScanner.java b/stecker-plugin-loader/src/main/java/org/meridor/stecker/interfaces/ClassesScanner.java
@@ -13,12 +13,12 @@ public interface ClassesScanner {
 
     /**
      * Returns a mapping between extension point classes and plugin file classes. E.g. if extension point is
-     * an interface <b>A</b> and some plugin implements it in classes B and C then the mapping will be: A -> (B, C).
+     * an interface <b>A</b> and some plugin implements it in classes B and C then the mapping will be: A -&gt; (B, C).
      *
      * @param pluginFile      plugin file to process
      * @param extensionPoints a list of extension point classes
      * @return mapping from extension point to implementations from a plugin
-     * @throws org.meridor.stecker.PluginException
+     * @throws org.meridor.stecker.PluginException when something goes wrong during classes scanning
      */
     Map<Class, List<Class>> scan(Path pluginFile, List<Class> extensionPoints) throws PluginException;
 

diff --git a/stecker-plugin-loader/src/main/java/org/meridor/stecker/interfaces/DependencyChecker.java b/stecker-plugin-loader/src/main/java/org/meridor/stecker/interfaces/DependencyChecker.java
@@ -13,7 +13,7 @@ public interface DependencyChecker {
      *
      * @param pluginRegistry plugin registry object filled with data about all plugins
      * @param pluginMetadata checked plugin metadata
-     * @throws org.meridor.stecker.PluginException
+     * @throws org.meridor.stecker.PluginException when dependency issues occur
      */
     void check(PluginsAware pluginRegistry, PluginMetadata pluginMetadata) throws PluginException;
 

diff --git a/stecker-plugin-loader/src/main/java/org/meridor/stecker/interfaces/ManifestReader.java b/stecker-plugin-loader/src/main/java/org/meridor/stecker/interfaces/ManifestReader.java
@@ -12,6 +12,7 @@ public interface ManifestReader {
      *
      * @param pluginFile plugin file to process
      * @return plugin information in {@link org.meridor.stecker.PluginMetadata} format
+     * @throws org.meridor.stecker.PluginException when something goes wrong during manifest reading
      */
     PluginMetadata read(Path pluginFile) throws PluginException;
 

diff --git a/stecker-plugin-loader/src/main/java/org/meridor/stecker/interfaces/PluginsProvider.java b/stecker-plugin-loader/src/main/java/org/meridor/stecker/interfaces/PluginsProvider.java
@@ -15,7 +15,7 @@ public interface PluginsProvider {
      *
      * @param baseDirectory root directory to scan for plugins
      * @return list of paths that seems to be plugins
-     * @throws org.meridor.stecker.PluginException
+     * @throws org.meridor.stecker.PluginException when something goes wrong during base directory scanning
      */
     List<Path> provide(Path baseDirectory) throws PluginException;
 

diff --git a/stecker-plugin-loader/src/main/java/org/meridor/stecker/interfaces/ResourcesScanner.java b/stecker-plugin-loader/src/main/java/org/meridor/stecker/interfaces/ResourcesScanner.java
@@ -16,7 +16,7 @@ public interface ResourcesScanner {
      *
      * @param path depending on context can be a file or directory path
      * @return a list of matching resources
-     * @throws PluginException
+     * @throws org.meridor.stecker.PluginException when something goes wrong during resources scanning
      */
     List<Path> scan(Path path) throws PluginException;