From 08a2b1e4410cb5713f43227096780f0933b909d7 Mon Sep 17 00:00:00 2001 From: Daniel Beck Date: Mon, 8 Jan 2018 20:52:30 +0100 Subject: [PATCH] Update 'since FIXME' and 'since TODO' Javadoc tags --- core/src/main/java/hudson/ExtensionList.java | 2 +- core/src/main/java/hudson/XmlFile.java | 2 +- core/src/main/java/hudson/model/Cause.java | 2 +- core/src/main/java/hudson/model/ItemGroup.java | 8 ++++---- .../main/java/hudson/model/StringParameterDefinition.java | 2 +- core/src/main/java/hudson/model/StringParameterValue.java | 2 +- core/src/main/java/hudson/model/User.java | 6 +++--- core/src/main/java/hudson/security/AccessControlled.java | 2 +- core/src/main/java/hudson/slaves/JNLPLauncher.java | 4 ++-- core/src/main/java/hudson/util/ArgumentListBuilder.java | 2 +- core/src/main/java/hudson/util/AtomicFileWriter.java | 2 +- core/src/main/java/hudson/util/PluginServletFilter.java | 2 +- core/src/main/java/hudson/util/TimeUnit2.java | 6 +----- core/src/main/java/hudson/util/XStream2.java | 4 ++-- core/src/main/java/jenkins/AgentProtocol.java | 2 +- core/src/main/java/jenkins/install/SetupWizard.java | 4 ++-- core/src/main/java/jenkins/model/Jenkins.java | 2 +- .../jenkins/security/csrf/CSRFAdministrativeMonitor.java | 2 +- .../jenkins/slaves/DeprecatedAgentProtocolMonitor.java | 2 +- .../main/java/jenkins/slaves/RemotingWorkDirSettings.java | 2 +- core/src/main/java/jenkins/util/TimeDuration.java | 2 +- 21 files changed, 29 insertions(+), 33 deletions(-) diff --git a/core/src/main/java/hudson/ExtensionList.java b/core/src/main/java/hudson/ExtensionList.java index 2420f05057..9a4c77d2f5 100644 --- a/core/src/main/java/hudson/ExtensionList.java +++ b/core/src/main/java/hudson/ExtensionList.java @@ -428,7 +428,7 @@ public class ExtensionList extends AbstractList implements OnMaster { * @return the singleton instance of the given type in its list. * @throws IllegalStateException if there are no instances, or more than one * - * @since TODO + * @since 2.87 */ public static @Nonnull U lookupSingleton(Class type) { ExtensionList all = lookup(type); diff --git a/core/src/main/java/hudson/XmlFile.java b/core/src/main/java/hudson/XmlFile.java index bde1ac12a4..243318e229 100644 --- a/core/src/main/java/hudson/XmlFile.java +++ b/core/src/main/java/hudson/XmlFile.java @@ -164,7 +164,7 @@ public final class XmlFile { /** * Variant of {@link #unmarshal(Object)} applying {@link XStream2#unmarshal(HierarchicalStreamReader, Object, DataHolder, boolean)}. - * @since FIXME + * @since 2.99 */ public Object unmarshalNullingOut(Object o) throws IOException { return unmarshal(o, true); diff --git a/core/src/main/java/hudson/model/Cause.java b/core/src/main/java/hudson/model/Cause.java index 7b16918f04..bdac357b6b 100644 --- a/core/src/main/java/hudson/model/Cause.java +++ b/core/src/main/java/hudson/model/Cause.java @@ -416,7 +416,7 @@ public abstract class Cause { /** * Constructor. * @param userId User ID. {@code null} if the user is unknown. - * @since TODO + * @since 2.96 */ public UserIdCause(@CheckForNull String userId) { this.userId = userId; diff --git a/core/src/main/java/hudson/model/ItemGroup.java b/core/src/main/java/hudson/model/ItemGroup.java index 12e4c19ee4..2397587a0b 100644 --- a/core/src/main/java/hudson/model/ItemGroup.java +++ b/core/src/main/java/hudson/model/ItemGroup.java @@ -93,7 +93,7 @@ public interface ItemGroup extends PersistenceRoot, ModelObject /** * Gets all the {@link Item}s recursively in the {@link ItemGroup} tree * and filter them by the given type. - * @since FIXME + * @since 2.93 */ default List getAllItems(Class type) { return Items.getAllItems(this, type); @@ -102,7 +102,7 @@ public interface ItemGroup extends PersistenceRoot, ModelObject /** * Gets all the {@link Item}s unordered, lazily and recursively in the {@link ItemGroup} tree * and filter them by the given type. - * @since FIXME + * @since 2.93 */ default Iterable allItems(Class type) { return Items.allItems(this, type); @@ -110,7 +110,7 @@ public interface ItemGroup extends PersistenceRoot, ModelObject /** * Gets all the items recursively. - * @since FIXME + * @since 2.93 */ default List getAllItems() { return getAllItems(Item.class); @@ -118,7 +118,7 @@ public interface ItemGroup extends PersistenceRoot, ModelObject /** * Gets all the items unordered, lazily and recursively. - * @since FIXME + * @since 2.93 */ default Iterable allItems() { return allItems(Item.class); diff --git a/core/src/main/java/hudson/model/StringParameterDefinition.java b/core/src/main/java/hudson/model/StringParameterDefinition.java index f8308d8397..3573199a01 100644 --- a/core/src/main/java/hudson/model/StringParameterDefinition.java +++ b/core/src/main/java/hudson/model/StringParameterDefinition.java @@ -92,7 +92,7 @@ public class StringParameterDefinition extends SimpleParameterDefinition { * @return trim - {@code true}, if trim options has been selected, else return {@code false}. * Trimming will happen when creating {@link StringParameterValue}s, * the value in the config will not be changed. - * @since TODO + * @since 2.90 */ public boolean isTrim() { return trim; diff --git a/core/src/main/java/hudson/model/StringParameterValue.java b/core/src/main/java/hudson/model/StringParameterValue.java index 14c2e947cb..a1bf1516e8 100644 --- a/core/src/main/java/hudson/model/StringParameterValue.java +++ b/core/src/main/java/hudson/model/StringParameterValue.java @@ -76,7 +76,7 @@ public class StringParameterValue extends ParameterValue { /** * Trimming for value - * @since TODO + * @since 2.90 */ public void doTrim() { if (value != null) { diff --git a/core/src/main/java/hudson/model/User.java b/core/src/main/java/hudson/model/User.java index 418e49aa0d..7f132023b7 100644 --- a/core/src/main/java/hudson/model/User.java +++ b/core/src/main/java/hudson/model/User.java @@ -587,7 +587,7 @@ public class User extends AbstractModelObject implements AccessControlled, Descr * * @param idOrFullName User ID or full name * @return User instance. It will be created on-demand. - * @since TODO + * @since 2.91 */ public static @Nonnull User getOrCreateByIdOrFullName(@Nonnull String idOrFullName) { return get(idOrFullName,true, Collections.emptyMap()); @@ -1172,7 +1172,7 @@ public class User extends AbstractModelObject implements AccessControlled, Descr /** * Gets all extension points, sorted by priority. * @return Sorted list of extension point implementations. - * @since TODO + * @since 2.93 */ public static List all() { List resolvers = new ArrayList<>(ExtensionList.lookup(CanonicalIdResolver.class)); @@ -1185,7 +1185,7 @@ public class User extends AbstractModelObject implements AccessControlled, Descr * @param idOrFullName ID or full name of the user * @param context Context * @return Resolved User ID or {@code null} if the user ID cannot be resolved. - * @since TODO + * @since 2.93 */ @CheckForNull public static String resolve(@Nonnull String idOrFullName, @Nonnull Map context) { diff --git a/core/src/main/java/hudson/security/AccessControlled.java b/core/src/main/java/hudson/security/AccessControlled.java index 5a2b246a2b..9aa084df2b 100644 --- a/core/src/main/java/hudson/security/AccessControlled.java +++ b/core/src/main/java/hudson/security/AccessControlled.java @@ -56,7 +56,7 @@ public interface AccessControlled { /** * Convenient short-cut for {@code getACL().hasPermission(a, permission)} - * @since FIXME + * @since 2.92 */ default boolean hasPermission(@Nonnull Authentication a, @Nonnull Permission permission) { if (a == ACL.SYSTEM) { diff --git a/core/src/main/java/hudson/slaves/JNLPLauncher.java b/core/src/main/java/hudson/slaves/JNLPLauncher.java index d0852590c3..eeafc2bb7f 100644 --- a/core/src/main/java/hudson/slaves/JNLPLauncher.java +++ b/core/src/main/java/hudson/slaves/JNLPLauncher.java @@ -115,7 +115,7 @@ public class JNLPLauncher extends ComputerLauncher { /** * Returns work directory settings. * - * @since TODO + * @since 2.72 */ @Nonnull public RemotingWorkDirSettings getWorkDirSettings() { @@ -172,7 +172,7 @@ public class JNLPLauncher extends ComputerLauncher { * By default the configuration is displayed only for {@link JNLPLauncher}, * but the implementation can be overridden. * @return {@code true} if work directories are supported by the launcher type. - * @since TODO + * @since 2.73 */ public boolean isWorkDirSupported() { // This property is included only for JNLPLauncher by default. diff --git a/core/src/main/java/hudson/util/ArgumentListBuilder.java b/core/src/main/java/hudson/util/ArgumentListBuilder.java index fb488b2471..4388a7abb4 100644 --- a/core/src/main/java/hudson/util/ArgumentListBuilder.java +++ b/core/src/main/java/hudson/util/ArgumentListBuilder.java @@ -135,7 +135,7 @@ public class ArgumentListBuilder implements Serializable, Cloneable { } /** - * @since TODO + * @since 2.72 */ public ArgumentListBuilder add(@Nonnull Iterable args) { for (String arg : args) { diff --git a/core/src/main/java/hudson/util/AtomicFileWriter.java b/core/src/main/java/hudson/util/AtomicFileWriter.java index d63be2648c..7ab9f09383 100644 --- a/core/src/main/java/hudson/util/AtomicFileWriter.java +++ b/core/src/main/java/hudson/util/AtomicFileWriter.java @@ -216,7 +216,7 @@ public class AtomicFileWriter extends Writer { /** * Until the data is committed, this file captures * the written content. - * @since TODO + * @since 2.93 */ public Path getTemporaryPath() { return tmpPath; diff --git a/core/src/main/java/hudson/util/PluginServletFilter.java b/core/src/main/java/hudson/util/PluginServletFilter.java index aa2c53973e..7f7172240a 100644 --- a/core/src/main/java/hudson/util/PluginServletFilter.java +++ b/core/src/main/java/hudson/util/PluginServletFilter.java @@ -117,7 +117,7 @@ public class PluginServletFilter implements Filter, ExtensionPoint { * Checks whether the given filter is already registered in the chain. * @param filter the filter to check. * @return true if the filter is already registered in the chain. - * @since FIXME + * @since 2.94 */ public static boolean hasFilter(Filter filter) { Jenkins j = Jenkins.getInstanceOrNull(); diff --git a/core/src/main/java/hudson/util/TimeUnit2.java b/core/src/main/java/hudson/util/TimeUnit2.java index a70c69599c..36b465764d 100644 --- a/core/src/main/java/hudson/util/TimeUnit2.java +++ b/core/src/main/java/hudson/util/TimeUnit2.java @@ -65,13 +65,12 @@ import java.util.concurrent.TimeUnit; * implementation will be able to notice the passage of time at the * same granularity as the given TimeUnit. * - * @since 1.5 * @author Doug Lea * @deprecated use {@link TimeUnit}. (Java 5 did not have all the units required, so {@link TimeUnit2} was introduced * because it had better conversion until Java 6 went out.) */ @Deprecated -@RestrictedSince("TODO") +@RestrictedSince("2.80") @Restricted(NoExternalUse.class) public enum TimeUnit2 { NANOSECONDS { @@ -286,7 +285,6 @@ public enum TimeUnit2 { * or Long.MIN_VALUE if conversion would negatively * overflow, or Long.MAX_VALUE if it would positively overflow. * @see #convert - * @since 1.6 */ public long toMinutes(long duration) { throw new AbstractMethodError(); @@ -299,7 +297,6 @@ public enum TimeUnit2 { * or Long.MIN_VALUE if conversion would negatively * overflow, or Long.MAX_VALUE if it would positively overflow. * @see #convert - * @since 1.6 */ public long toHours(long duration) { throw new AbstractMethodError(); @@ -310,7 +307,6 @@ public enum TimeUnit2 { * @param duration the duration * @return the converted duration * @see #convert - * @since 1.6 */ public long toDays(long duration) { throw new AbstractMethodError(); diff --git a/core/src/main/java/hudson/util/XStream2.java b/core/src/main/java/hudson/util/XStream2.java index 9d4ef9b99b..b77bb52d18 100644 --- a/core/src/main/java/hudson/util/XStream2.java +++ b/core/src/main/java/hudson/util/XStream2.java @@ -131,7 +131,7 @@ public class XStream2 extends XStream { * false to use the stock XStream behavior of leaving unmentioned {@code root} fields untouched * @see XmlFile#unmarshalNullingOut * @see JENKINS-21017 - * @since FIXME + * @since 2.99 */ public Object unmarshal(HierarchicalStreamReader reader, Object root, DataHolder dataHolder, boolean nullOut) { // init() is too early to do this @@ -207,7 +207,7 @@ public class XStream2 extends XStream { * Specifies that a given field of a given class should not be treated with laxity by {@link RobustCollectionConverter}. * @param clazz a class which we expect to hold a non-{@code transient} field * @param field a field name in that class - * @since TODO + * @since 2.85 this method can be used from outside core, before then it was restricted since initially added in 1.551 / 1.532.2 */ public void addCriticalField(Class clazz, String field) { reflectionConverter.addCriticalField(clazz, field); diff --git a/core/src/main/java/jenkins/AgentProtocol.java b/core/src/main/java/jenkins/AgentProtocol.java index f4917b3996..587fdefa69 100644 --- a/core/src/main/java/jenkins/AgentProtocol.java +++ b/core/src/main/java/jenkins/AgentProtocol.java @@ -68,7 +68,7 @@ public abstract class AgentProtocol implements ExtensionPoint { /** * Checks if the protocol is deprecated. * - * @since TODO + * @since 2.75 */ public boolean isDeprecated() { return false; diff --git a/core/src/main/java/jenkins/install/SetupWizard.java b/core/src/main/java/jenkins/install/SetupWizard.java index f15b468eed..6c70482369 100644 --- a/core/src/main/java/jenkins/install/SetupWizard.java +++ b/core/src/main/java/jenkins/install/SetupWizard.java @@ -519,7 +519,7 @@ public class SetupWizard extends PageDecorator { /** * Called upon install state update. * @param state the new install state. - * @since FIXME + * @since 2.94 */ public void onInstallStateUpdate(InstallState state) { if (state.isSetupComplete()) { @@ -531,7 +531,7 @@ public class SetupWizard extends PageDecorator { /** * Returns whether the setup wizard filter is currently registered. - * @since FIXME + * @since 2.94 */ public boolean hasSetupWizardFilter() { return PluginServletFilter.hasFilter(FORCE_SETUP_WIZARD_FILTER); diff --git a/core/src/main/java/jenkins/model/Jenkins.java b/core/src/main/java/jenkins/model/Jenkins.java index 4a9410e7bc..a8787e050c 100644 --- a/core/src/main/java/jenkins/model/Jenkins.java +++ b/core/src/main/java/jenkins/model/Jenkins.java @@ -740,7 +740,7 @@ public class Jenkins extends AbstractCIBase implements DirectlyModifiableTopLeve * Gets the {@link Jenkins} singleton. * @return {@link Jenkins} instance * @throws IllegalStateException for the reasons that {@link #getInstanceOrNull} might return null - * @since FIXME + * @since 2.98 */ @Nonnull public static Jenkins get() throws IllegalStateException { diff --git a/core/src/main/java/jenkins/security/csrf/CSRFAdministrativeMonitor.java b/core/src/main/java/jenkins/security/csrf/CSRFAdministrativeMonitor.java index d942c5cab5..dbdb38e337 100644 --- a/core/src/main/java/jenkins/security/csrf/CSRFAdministrativeMonitor.java +++ b/core/src/main/java/jenkins/security/csrf/CSRFAdministrativeMonitor.java @@ -33,7 +33,7 @@ import org.kohsuke.accmod.restrictions.NoExternalUse; /** * Monitor that the CSRF protection is enabled on the application. * - * @since TODO + * @since 2.85 */ @Extension @Symbol("csrf") diff --git a/core/src/main/java/jenkins/slaves/DeprecatedAgentProtocolMonitor.java b/core/src/main/java/jenkins/slaves/DeprecatedAgentProtocolMonitor.java index f519e4ecb6..96886fc996 100644 --- a/core/src/main/java/jenkins/slaves/DeprecatedAgentProtocolMonitor.java +++ b/core/src/main/java/jenkins/slaves/DeprecatedAgentProtocolMonitor.java @@ -41,7 +41,7 @@ import org.kohsuke.accmod.restrictions.NoExternalUse; * Monitors enabled protocols and warns if an {@link AgentProtocol} is deprecated. * * @author Oleg Nenashev - * @since TODO + * @since 2.75 * @see AgentProtocol */ @Extension diff --git a/core/src/main/java/jenkins/slaves/RemotingWorkDirSettings.java b/core/src/main/java/jenkins/slaves/RemotingWorkDirSettings.java index c82a040145..6e998bc74d 100644 --- a/core/src/main/java/jenkins/slaves/RemotingWorkDirSettings.java +++ b/core/src/main/java/jenkins/slaves/RemotingWorkDirSettings.java @@ -46,7 +46,7 @@ import org.kohsuke.stapler.DataBoundConstructor; * See Remoting Work Dir Documentation. * * @author Oleg Nenashev - * @since TODO + * @since 2.72 */ public class RemotingWorkDirSettings implements Describable { diff --git a/core/src/main/java/jenkins/util/TimeDuration.java b/core/src/main/java/jenkins/util/TimeDuration.java index 61fa51f99d..8b0fff3f5e 100644 --- a/core/src/main/java/jenkins/util/TimeDuration.java +++ b/core/src/main/java/jenkins/util/TimeDuration.java @@ -43,7 +43,7 @@ public class TimeDuration { /** * Returns the duration of this instance in seconds. - * @since TODO + * @since 2.82 */ public int getTimeInSeconds() { return (int) (millis / 1000L); -- GitLab