From b0c0698e5503c2506217117bf144fde31e6f6601 Mon Sep 17 00:00:00 2001 From: Eduardo Pedroni Date: Fri, 25 Apr 2014 19:38:16 +0100 Subject: Commented lots of packages. --- src/jcgp/backend/modules/Module.java | 14 ++++++++++++++ 1 file changed, 14 insertions(+) (limited to 'src/jcgp/backend/modules/Module.java') diff --git a/src/jcgp/backend/modules/Module.java b/src/jcgp/backend/modules/Module.java index a6b4d73..7efbf3a 100644 --- a/src/jcgp/backend/modules/Module.java +++ b/src/jcgp/backend/modules/Module.java @@ -2,8 +2,22 @@ package jcgp.backend.modules; import jcgp.backend.resources.parameters.Parameter; +/** + * This interface defines the expected behaviour of a module. Specifically, a module + * is expected to be able to return a list of local parameters. When a user interface + * is used, it is expected to display the parameters of each module and allow user + * interaction for parameters which are not monitors. + * + * @see Parameter + * + * @author Eduardo Pedroni + * + */ public interface Module { + /** + * @return a list of generic parameters exposed by the module. + */ public abstract Parameter[] getLocalParameters(); } -- cgit v1.2.3