[JIRA] (JENKINS-42590) code or javadoc is wrong to hide a descriptor.

[jn...@cloudbees.com (JIRA)]

Title: Message Title

James Nord created an issue   Jenkins / JENKINS-42590 code or javadoc is wrong to hide a descriptor. Issue Type: Bug Assignee: Unassigned Components: core Created: 2017/Mar/08 5:11 PM Priority: Major Reporter: James Nord  Jenkins code contradicts itself - leaving a developer to go "WUT"? hudson.model.Descriptor.getDisplayName() /** * Human readable name of this kind of configurable object. * Should be overridden for most descriptors, if the display name is visible somehow. * As a fallback it uses {@link Class#getSimpleName} on {@link #clazz}, so for example {@code MyThing} from {@code some.pkg.MyThing.DescriptorImpl}. * Historically some implementations returned null as a way of hiding the descriptor from the UI, * but this is generally managed by an explicit method such as {@code isEnabled} or {@code isApplicable}. */ @Nonnull public String getDisplayName() { return clazz.getSimpleName(); } hudson.model.ReconfigurableDescribable * <h1>Use Cases</h1> * <h2>Invisible Property</h2> * <p> * This mechanism can be used to create an entirely invisible {@link Describable}, which is handy * for {@link NodeProperty}, {@link JobProperty}, etc. To do so, define a descriptor with null * {@linkplain Descriptor#getDisplayName() display name} and empty config.jelly to prevent it from * showing up in the config UI, then implement {@link #reconfigure(StaplerRequest, JSONObject)} * and simply return {@code this}. So some code says to hide things use null in getDisplayName() - yet getDisplayName() is non-null. Add Comment   This message was sent by Atlassian JIRA (v7.3.0#73011-sha1:3c73d0e) -- You received this message because you are subscribed to the Google Groups "Jenkins Issues" group. To unsubscribe from this group and stop receiving emails from it, send an email to jenkinsci-issues+unsubscr...@googlegroups.com. For more options, visit https://groups.google.com/d/optout.