From 8b0540a6d74f6a3f11eef3c2be1dc62ea3cb145b Mon Sep 17 00:00:00 2001 From: kohsuke Date: Wed, 8 Aug 2007 04:39:13 +0000 Subject: [PATCH] doc improvement. git-svn-id: https://hudson.dev.java.net/svn/hudson/trunk/hudson/main@4134 71c3de6d-444a-0410-be80-ed276b4c234a --- core/src/main/java/hudson/model/Action.java | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/core/src/main/java/hudson/model/Action.java b/core/src/main/java/hudson/model/Action.java index 4c20cc36b6..d3db90e664 100644 --- a/core/src/main/java/hudson/model/Action.java +++ b/core/src/main/java/hudson/model/Action.java @@ -56,6 +56,14 @@ public interface Action extends Serializable, ModelObject { /** * Gets the URL path name. + * + *

+ * For example, if this method returns "xyz", and if the parent object + * (that this action is associated with) is bound to /foo/bar/zot, + * then this action object will be exposed to /foo/bar/zot/xyz. + * + *

+ * This method should return a string that's unique among other {@link Action}s. */ String getUrlName(); }