diff options
author | Decebal Suiu <decebal.suiu@gmail.com> | 2019-04-12 21:26:07 +0300 |
---|---|---|
committer | Decebal Suiu <decebal.suiu@gmail.com> | 2019-04-12 21:26:07 +0300 |
commit | 293b020dee0f63f1f7c23f1db4e34b6415f1e32f (patch) | |
tree | 2658635c2bfc5073514f21d1a80ab1d62554580e | |
parent | 74d9637f403e6b2e1db950c62463e05bf2cbc969 (diff) | |
download | pf4j-293b020dee0f63f1f7c23f1db4e34b6415f1e32f.tar.gz pf4j-293b020dee0f63f1f7c23f1db4e34b6415f1e32f.zip |
Fix javadoc formatting
-rw-r--r-- | pf4j/src/main/java/module-info.java.new | 47 | ||||
-rw-r--r-- | pf4j/src/main/java/org/pf4j/ZipPluginManager.java | 6 |
2 files changed, 51 insertions, 2 deletions
diff --git a/pf4j/src/main/java/module-info.java.new b/pf4j/src/main/java/module-info.java.new new file mode 100644 index 0000000..754b9b8 --- /dev/null +++ b/pf4j/src/main/java/module-info.java.new @@ -0,0 +1,47 @@ +/* + * Copyright (C) 2012-present the original author or authors. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +/** + * Module descriptor for PF4J. + * + * @author Decebal Suiu + * @author Andreas Rudolph + */ +module org.pf4j { + requires java.base; + + // provides javax.annotation + requires java.compiler; + + // provided by the ASM library + requires org.objectweb.asm; + + // The SLF4J library currently does not provide a module. + // Version 1.8 provides a module called "org.slf4j". But this version is + // currently in beta stage. Therefore I'm not sure, if we already like to + // use it. + requires slf4j.api; + + // The java-semver library currently does not provide a module. + // Maybe we should send them a pull request, that at least they provide an + // automatic module name in their MANIFEST file. + requires java.semver; + + // Maybe we should reconsider the package hierarchy, that only classes are + // exported, which are required by 3rd party developers. + exports org.pf4j; + exports org.pf4j.processor; +} diff --git a/pf4j/src/main/java/org/pf4j/ZipPluginManager.java b/pf4j/src/main/java/org/pf4j/ZipPluginManager.java index ed2ea7e..ab17fc9 100644 --- a/pf4j/src/main/java/org/pf4j/ZipPluginManager.java +++ b/pf4j/src/main/java/org/pf4j/ZipPluginManager.java @@ -18,8 +18,10 @@ package org.pf4j; /** * It's a {@link PluginManager} that loads each plugin from a {@code zip} file. * The structure of the zip file is: - * - {@code lib} directory that contains all dependencies (as jar files); it's optional (no dependencies) - * - {@code classes} directory that contains all plugin's classes + * <ul> + * <li>{@code lib} directory that contains all dependencies (as jar files); it's optional (no dependencies) + * <li>{@code classes} directory that contains all plugin's classes + * </ul> * * @author Decebal Suiu */ |