Browse Source

Fix javadoc formatting

async
Decebal Suiu 6 years ago
parent
commit
293b020dee
  1. 47
      pf4j/src/main/java/module-info.java.new
  2. 6
      pf4j/src/main/java/org/pf4j/ZipPluginManager.java

47
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;
}

6
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. * It's a {@link PluginManager} that loads each plugin from a {@code zip} file.
* The structure of the zip file is: * The structure of the zip file is:
* - {@code lib} directory that contains all dependencies (as jar files); it's optional (no dependencies) * <ul>
* - {@code classes} directory that contains all plugin's classes * <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 * @author Decebal Suiu
*/ */

Loading…
Cancel
Save