From 84c856b3591b10b192bd6bb452d0760933a33b35 Mon Sep 17 00:00:00 2001 From: Decebal Suiu Date: Thu, 29 Jun 2017 23:50:45 +0300 Subject: [PATCH] Add javadoc for DependencyResolver class --- .../main/java/ro/fortsoft/pf4j/DependencyResolver.java | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/pf4j/src/main/java/ro/fortsoft/pf4j/DependencyResolver.java b/pf4j/src/main/java/ro/fortsoft/pf4j/DependencyResolver.java index 65c2f33..3ab5526 100644 --- a/pf4j/src/main/java/ro/fortsoft/pf4j/DependencyResolver.java +++ b/pf4j/src/main/java/ro/fortsoft/pf4j/DependencyResolver.java @@ -27,6 +27,15 @@ import java.util.List; import java.util.Map; /** + * This class builds a dependency graph for a list of plugins (descriptors). + * The entry point is the {@link #resolve(List)} method, method that returns a {@link Result} object. + * The {@code Result} class contains nice information about the result of resolve operation (if it's a cyclic dependency, + * they are not found dependencies, they are dependencies with wrong version). + * This class is very useful for if-else scenarios. + * + * Only some attributes (pluginId, dependencies and pluginVersion) from {@link PluginDescriptor} are used in + * the process of {@code resolve} operation. + * * @author Decebal Suiu */ public class DependencyResolver {