update Renamable javadoc

jenkinsci · Sep 7, 2023 · b7eed6f · b7eed6f
1 parent 73f451e
commit b7eed6f
Showing 1 changed file with 9 additions and 3 deletions.
diff --git a/core/src/main/java/hudson/model/Renamable.java b/core/src/main/java/hudson/model/Renamable.java
@@ -26,31 +26,37 @@
 
 import edu.umd.cs.findbugs.annotations.NonNull;
 import hudson.util.FormValidation;
+import org.kohsuke.accmod.Restricted;
+import org.kohsuke.accmod.restrictions.ProtectedExternally;
 import org.kohsuke.stapler.HttpResponse;
 import org.kohsuke.stapler.QueryParameter;
 
+/**
+ * Interface used to create a dedicated page that changes the name property of an Object.
+ * See also {@link jenkins.model.RenameAction}.
+ *
+ * @since TODO
+ */
+@Restricted(ProtectedExternally.class)
 public interface Renamable {
 
     /**
      * Controls whether the default rename action is available for this object.
      *
      * @return whether the name can be modified by a user
-     * @since TODO
      */
     boolean isNameEditable();
 
     /**
      * Renames the object
      *
-     * @since TODO
      */
     HttpResponse doConfirmRename(@QueryParameter String newName) throws Exception;
 
     /**
      * Controls whether the default rename action is available.
      *
      * @return whether object name can be modified by a user
-     * @since TODO
      */
     @NonNull
     FormValidation doCheckNewName(@QueryParameter String newName);