Mercurial > dive4elements > gnv-client
diff gnv-artifacts/src/main/java/de/intevation/gnv/artifacts/services/requestobjects/Parameter.java @ 792:9b9bf42b7928
Added and repaired JavaDoc in artifacts package.
gnv-artifacts/trunk@874 c6561f87-3c4e-4783-a992-168aeb5c3f6f
| author | Ingo Weinzierl <ingo.weinzierl@intevation.de> |
|---|---|
| date | Wed, 31 Mar 2010 10:52:34 +0000 |
| parents | c4156275c1e1 |
| children | 32d01e1ce2df |
line wrap: on
line diff
--- a/gnv-artifacts/src/main/java/de/intevation/gnv/artifacts/services/requestobjects/Parameter.java Wed Mar 31 09:30:34 2010 +0000 +++ b/gnv-artifacts/src/main/java/de/intevation/gnv/artifacts/services/requestobjects/Parameter.java Wed Mar 31 10:52:34 2010 +0000 @@ -1,12 +1,27 @@ package de.intevation.gnv.artifacts.services.requestobjects; /** + * This is the interface description of <code>Parameter</code>. Currently, there + * are two methods defined:<br> + * <ol> + * <li>getName(): Returns the name of this parameter.</li> + * <li>getID(): Returns the id of this parameter.</li> + * </ol> + * * @author <a href="mailto:tim.englich@intevation.de">Tim Englich</a> - * */ public interface Parameter { + /** + * + * @return the name of this parameter. + */ String getName(); - String getID (); + /** + * + * @return the id of this parameter. + */ + String getID(); } +// vim:set ts=4 sw=4 si et sta sts=4 fenc=utf8 : \ No newline at end of file