提交 08a2b1e4 编写于 作者: D Daniel Beck

Update 'since FIXME' and 'since TODO' Javadoc tags

上级 d6ff7647
...@@ -428,7 +428,7 @@ public class ExtensionList<T> extends AbstractList<T> implements OnMaster { ...@@ -428,7 +428,7 @@ public class ExtensionList<T> extends AbstractList<T> implements OnMaster {
* @return the singleton instance of the given type in its list. * @return the singleton instance of the given type in its list.
* @throws IllegalStateException if there are no instances, or more than one * @throws IllegalStateException if there are no instances, or more than one
* *
* @since TODO * @since 2.87
*/ */
public static @Nonnull <U> U lookupSingleton(Class<U> type) { public static @Nonnull <U> U lookupSingleton(Class<U> type) {
ExtensionList<U> all = lookup(type); ExtensionList<U> all = lookup(type);
......
...@@ -164,7 +164,7 @@ public final class XmlFile { ...@@ -164,7 +164,7 @@ public final class XmlFile {
/** /**
* Variant of {@link #unmarshal(Object)} applying {@link XStream2#unmarshal(HierarchicalStreamReader, Object, DataHolder, boolean)}. * 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 { public Object unmarshalNullingOut(Object o) throws IOException {
return unmarshal(o, true); return unmarshal(o, true);
......
...@@ -416,7 +416,7 @@ public abstract class Cause { ...@@ -416,7 +416,7 @@ public abstract class Cause {
/** /**
* Constructor. * Constructor.
* @param userId User ID. {@code null} if the user is unknown. * @param userId User ID. {@code null} if the user is unknown.
* @since TODO * @since 2.96
*/ */
public UserIdCause(@CheckForNull String userId) { public UserIdCause(@CheckForNull String userId) {
this.userId = userId; this.userId = userId;
......
...@@ -93,7 +93,7 @@ public interface ItemGroup<T extends Item> extends PersistenceRoot, ModelObject ...@@ -93,7 +93,7 @@ public interface ItemGroup<T extends Item> extends PersistenceRoot, ModelObject
/** /**
* Gets all the {@link Item}s recursively in the {@link ItemGroup} tree * Gets all the {@link Item}s recursively in the {@link ItemGroup} tree
* and filter them by the given type. * and filter them by the given type.
* @since FIXME * @since 2.93
*/ */
default <T extends Item> List<T> getAllItems(Class<T> type) { default <T extends Item> List<T> getAllItems(Class<T> type) {
return Items.getAllItems(this, type); return Items.getAllItems(this, type);
...@@ -102,7 +102,7 @@ public interface ItemGroup<T extends Item> extends PersistenceRoot, ModelObject ...@@ -102,7 +102,7 @@ public interface ItemGroup<T extends Item> extends PersistenceRoot, ModelObject
/** /**
* Gets all the {@link Item}s unordered, lazily and recursively in the {@link ItemGroup} tree * Gets all the {@link Item}s unordered, lazily and recursively in the {@link ItemGroup} tree
* and filter them by the given type. * and filter them by the given type.
* @since FIXME * @since 2.93
*/ */
default <T extends Item> Iterable<T> allItems(Class<T> type) { default <T extends Item> Iterable<T> allItems(Class<T> type) {
return Items.allItems(this, type); return Items.allItems(this, type);
...@@ -110,7 +110,7 @@ public interface ItemGroup<T extends Item> extends PersistenceRoot, ModelObject ...@@ -110,7 +110,7 @@ public interface ItemGroup<T extends Item> extends PersistenceRoot, ModelObject
/** /**
* Gets all the items recursively. * Gets all the items recursively.
* @since FIXME * @since 2.93
*/ */
default List<Item> getAllItems() { default List<Item> getAllItems() {
return getAllItems(Item.class); return getAllItems(Item.class);
...@@ -118,7 +118,7 @@ public interface ItemGroup<T extends Item> extends PersistenceRoot, ModelObject ...@@ -118,7 +118,7 @@ public interface ItemGroup<T extends Item> extends PersistenceRoot, ModelObject
/** /**
* Gets all the items unordered, lazily and recursively. * Gets all the items unordered, lazily and recursively.
* @since FIXME * @since 2.93
*/ */
default Iterable<Item> allItems() { default Iterable<Item> allItems() {
return allItems(Item.class); return allItems(Item.class);
......
...@@ -92,7 +92,7 @@ public class StringParameterDefinition extends SimpleParameterDefinition { ...@@ -92,7 +92,7 @@ public class StringParameterDefinition extends SimpleParameterDefinition {
* @return trim - {@code true}, if trim options has been selected, else return {@code false}. * @return trim - {@code true}, if trim options has been selected, else return {@code false}.
* Trimming will happen when creating {@link StringParameterValue}s, * Trimming will happen when creating {@link StringParameterValue}s,
* the value in the config will not be changed. * the value in the config will not be changed.
* @since TODO * @since 2.90
*/ */
public boolean isTrim() { public boolean isTrim() {
return trim; return trim;
......
...@@ -76,7 +76,7 @@ public class StringParameterValue extends ParameterValue { ...@@ -76,7 +76,7 @@ public class StringParameterValue extends ParameterValue {
/** /**
* Trimming for value * Trimming for value
* @since TODO * @since 2.90
*/ */
public void doTrim() { public void doTrim() {
if (value != null) { if (value != null) {
......
...@@ -587,7 +587,7 @@ public class User extends AbstractModelObject implements AccessControlled, Descr ...@@ -587,7 +587,7 @@ public class User extends AbstractModelObject implements AccessControlled, Descr
* *
* @param idOrFullName User ID or full name * @param idOrFullName User ID or full name
* @return User instance. It will be created on-demand. * @return User instance. It will be created on-demand.
* @since TODO * @since 2.91
*/ */
public static @Nonnull User getOrCreateByIdOrFullName(@Nonnull String idOrFullName) { public static @Nonnull User getOrCreateByIdOrFullName(@Nonnull String idOrFullName) {
return get(idOrFullName,true, Collections.emptyMap()); return get(idOrFullName,true, Collections.emptyMap());
...@@ -1172,7 +1172,7 @@ public class User extends AbstractModelObject implements AccessControlled, Descr ...@@ -1172,7 +1172,7 @@ public class User extends AbstractModelObject implements AccessControlled, Descr
/** /**
* Gets all extension points, sorted by priority. * Gets all extension points, sorted by priority.
* @return Sorted list of extension point implementations. * @return Sorted list of extension point implementations.
* @since TODO * @since 2.93
*/ */
public static List<CanonicalIdResolver> all() { public static List<CanonicalIdResolver> all() {
List<CanonicalIdResolver> resolvers = new ArrayList<>(ExtensionList.lookup(CanonicalIdResolver.class)); List<CanonicalIdResolver> resolvers = new ArrayList<>(ExtensionList.lookup(CanonicalIdResolver.class));
...@@ -1185,7 +1185,7 @@ public class User extends AbstractModelObject implements AccessControlled, Descr ...@@ -1185,7 +1185,7 @@ public class User extends AbstractModelObject implements AccessControlled, Descr
* @param idOrFullName ID or full name of the user * @param idOrFullName ID or full name of the user
* @param context Context * @param context Context
* @return Resolved User ID or {@code null} if the user ID cannot be resolved. * @return Resolved User ID or {@code null} if the user ID cannot be resolved.
* @since TODO * @since 2.93
*/ */
@CheckForNull @CheckForNull
public static String resolve(@Nonnull String idOrFullName, @Nonnull Map<String, ?> context) { public static String resolve(@Nonnull String idOrFullName, @Nonnull Map<String, ?> context) {
......
...@@ -56,7 +56,7 @@ public interface AccessControlled { ...@@ -56,7 +56,7 @@ public interface AccessControlled {
/** /**
* Convenient short-cut for {@code getACL().hasPermission(a, permission)} * Convenient short-cut for {@code getACL().hasPermission(a, permission)}
* @since FIXME * @since 2.92
*/ */
default boolean hasPermission(@Nonnull Authentication a, @Nonnull Permission permission) { default boolean hasPermission(@Nonnull Authentication a, @Nonnull Permission permission) {
if (a == ACL.SYSTEM) { if (a == ACL.SYSTEM) {
......
...@@ -115,7 +115,7 @@ public class JNLPLauncher extends ComputerLauncher { ...@@ -115,7 +115,7 @@ public class JNLPLauncher extends ComputerLauncher {
/** /**
* Returns work directory settings. * Returns work directory settings.
* *
* @since TODO * @since 2.72
*/ */
@Nonnull @Nonnull
public RemotingWorkDirSettings getWorkDirSettings() { public RemotingWorkDirSettings getWorkDirSettings() {
...@@ -172,7 +172,7 @@ public class JNLPLauncher extends ComputerLauncher { ...@@ -172,7 +172,7 @@ public class JNLPLauncher extends ComputerLauncher {
* By default the configuration is displayed only for {@link JNLPLauncher}, * By default the configuration is displayed only for {@link JNLPLauncher},
* but the implementation can be overridden. * but the implementation can be overridden.
* @return {@code true} if work directories are supported by the launcher type. * @return {@code true} if work directories are supported by the launcher type.
* @since TODO * @since 2.73
*/ */
public boolean isWorkDirSupported() { public boolean isWorkDirSupported() {
// This property is included only for JNLPLauncher by default. // This property is included only for JNLPLauncher by default.
......
...@@ -135,7 +135,7 @@ public class ArgumentListBuilder implements Serializable, Cloneable { ...@@ -135,7 +135,7 @@ public class ArgumentListBuilder implements Serializable, Cloneable {
} }
/** /**
* @since TODO * @since 2.72
*/ */
public ArgumentListBuilder add(@Nonnull Iterable<String> args) { public ArgumentListBuilder add(@Nonnull Iterable<String> args) {
for (String arg : args) { for (String arg : args) {
......
...@@ -216,7 +216,7 @@ public class AtomicFileWriter extends Writer { ...@@ -216,7 +216,7 @@ public class AtomicFileWriter extends Writer {
/** /**
* Until the data is committed, this file captures * Until the data is committed, this file captures
* the written content. * the written content.
* @since TODO * @since 2.93
*/ */
public Path getTemporaryPath() { public Path getTemporaryPath() {
return tmpPath; return tmpPath;
......
...@@ -117,7 +117,7 @@ public class PluginServletFilter implements Filter, ExtensionPoint { ...@@ -117,7 +117,7 @@ public class PluginServletFilter implements Filter, ExtensionPoint {
* Checks whether the given filter is already registered in the chain. * Checks whether the given filter is already registered in the chain.
* @param filter the filter to check. * @param filter the filter to check.
* @return true if the filter is already registered in the chain. * @return true if the filter is already registered in the chain.
* @since FIXME * @since 2.94
*/ */
public static boolean hasFilter(Filter filter) { public static boolean hasFilter(Filter filter) {
Jenkins j = Jenkins.getInstanceOrNull(); Jenkins j = Jenkins.getInstanceOrNull();
......
...@@ -65,13 +65,12 @@ import java.util.concurrent.TimeUnit; ...@@ -65,13 +65,12 @@ import java.util.concurrent.TimeUnit;
* implementation will be able to notice the passage of time at the * implementation will be able to notice the passage of time at the
* same granularity as the given <tt>TimeUnit</tt>. * same granularity as the given <tt>TimeUnit</tt>.
* *
* @since 1.5
* @author Doug Lea * @author Doug Lea
* @deprecated use {@link TimeUnit}. (Java 5 did not have all the units required, so {@link TimeUnit2} was introduced * @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.) * because it had better conversion until Java 6 went out.)
*/ */
@Deprecated @Deprecated
@RestrictedSince("TODO") @RestrictedSince("2.80")
@Restricted(NoExternalUse.class) @Restricted(NoExternalUse.class)
public enum TimeUnit2 { public enum TimeUnit2 {
NANOSECONDS { NANOSECONDS {
...@@ -286,7 +285,6 @@ public enum TimeUnit2 { ...@@ -286,7 +285,6 @@ public enum TimeUnit2 {
* or <tt>Long.MIN_VALUE</tt> if conversion would negatively * or <tt>Long.MIN_VALUE</tt> if conversion would negatively
* overflow, or <tt>Long.MAX_VALUE</tt> if it would positively overflow. * overflow, or <tt>Long.MAX_VALUE</tt> if it would positively overflow.
* @see #convert * @see #convert
* @since 1.6
*/ */
public long toMinutes(long duration) { public long toMinutes(long duration) {
throw new AbstractMethodError(); throw new AbstractMethodError();
...@@ -299,7 +297,6 @@ public enum TimeUnit2 { ...@@ -299,7 +297,6 @@ public enum TimeUnit2 {
* or <tt>Long.MIN_VALUE</tt> if conversion would negatively * or <tt>Long.MIN_VALUE</tt> if conversion would negatively
* overflow, or <tt>Long.MAX_VALUE</tt> if it would positively overflow. * overflow, or <tt>Long.MAX_VALUE</tt> if it would positively overflow.
* @see #convert * @see #convert
* @since 1.6
*/ */
public long toHours(long duration) { public long toHours(long duration) {
throw new AbstractMethodError(); throw new AbstractMethodError();
...@@ -310,7 +307,6 @@ public enum TimeUnit2 { ...@@ -310,7 +307,6 @@ public enum TimeUnit2 {
* @param duration the duration * @param duration the duration
* @return the converted duration * @return the converted duration
* @see #convert * @see #convert
* @since 1.6
*/ */
public long toDays(long duration) { public long toDays(long duration) {
throw new AbstractMethodError(); throw new AbstractMethodError();
......
...@@ -131,7 +131,7 @@ public class XStream2 extends XStream { ...@@ -131,7 +131,7 @@ public class XStream2 extends XStream {
* false to use the stock XStream behavior of leaving unmentioned {@code root} fields untouched * false to use the stock XStream behavior of leaving unmentioned {@code root} fields untouched
* @see XmlFile#unmarshalNullingOut * @see XmlFile#unmarshalNullingOut
* @see <a href="https://issues.jenkins-ci.org/browse/JENKINS-21017">JENKINS-21017</a> * @see <a href="https://issues.jenkins-ci.org/browse/JENKINS-21017">JENKINS-21017</a>
* @since FIXME * @since 2.99
*/ */
public Object unmarshal(HierarchicalStreamReader reader, Object root, DataHolder dataHolder, boolean nullOut) { public Object unmarshal(HierarchicalStreamReader reader, Object root, DataHolder dataHolder, boolean nullOut) {
// init() is too early to do this // init() is too early to do this
...@@ -207,7 +207,7 @@ public class XStream2 extends XStream { ...@@ -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}. * 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 clazz a class which we expect to hold a non-{@code transient} field
* @param field a field name in that class * @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) { public void addCriticalField(Class<?> clazz, String field) {
reflectionConverter.addCriticalField(clazz, field); reflectionConverter.addCriticalField(clazz, field);
......
...@@ -68,7 +68,7 @@ public abstract class AgentProtocol implements ExtensionPoint { ...@@ -68,7 +68,7 @@ public abstract class AgentProtocol implements ExtensionPoint {
/** /**
* Checks if the protocol is deprecated. * Checks if the protocol is deprecated.
* *
* @since TODO * @since 2.75
*/ */
public boolean isDeprecated() { public boolean isDeprecated() {
return false; return false;
......
...@@ -519,7 +519,7 @@ public class SetupWizard extends PageDecorator { ...@@ -519,7 +519,7 @@ public class SetupWizard extends PageDecorator {
/** /**
* Called upon install state update. * Called upon install state update.
* @param state the new install state. * @param state the new install state.
* @since FIXME * @since 2.94
*/ */
public void onInstallStateUpdate(InstallState state) { public void onInstallStateUpdate(InstallState state) {
if (state.isSetupComplete()) { if (state.isSetupComplete()) {
...@@ -531,7 +531,7 @@ public class SetupWizard extends PageDecorator { ...@@ -531,7 +531,7 @@ public class SetupWizard extends PageDecorator {
/** /**
* Returns whether the setup wizard filter is currently registered. * Returns whether the setup wizard filter is currently registered.
* @since FIXME * @since 2.94
*/ */
public boolean hasSetupWizardFilter() { public boolean hasSetupWizardFilter() {
return PluginServletFilter.hasFilter(FORCE_SETUP_WIZARD_FILTER); return PluginServletFilter.hasFilter(FORCE_SETUP_WIZARD_FILTER);
......
...@@ -740,7 +740,7 @@ public class Jenkins extends AbstractCIBase implements DirectlyModifiableTopLeve ...@@ -740,7 +740,7 @@ public class Jenkins extends AbstractCIBase implements DirectlyModifiableTopLeve
* Gets the {@link Jenkins} singleton. * Gets the {@link Jenkins} singleton.
* @return {@link Jenkins} instance * @return {@link Jenkins} instance
* @throws IllegalStateException for the reasons that {@link #getInstanceOrNull} might return null * @throws IllegalStateException for the reasons that {@link #getInstanceOrNull} might return null
* @since FIXME * @since 2.98
*/ */
@Nonnull @Nonnull
public static Jenkins get() throws IllegalStateException { public static Jenkins get() throws IllegalStateException {
......
...@@ -33,7 +33,7 @@ import org.kohsuke.accmod.restrictions.NoExternalUse; ...@@ -33,7 +33,7 @@ import org.kohsuke.accmod.restrictions.NoExternalUse;
/** /**
* Monitor that the CSRF protection is enabled on the application. * Monitor that the CSRF protection is enabled on the application.
* *
* @since TODO * @since 2.85
*/ */
@Extension @Extension
@Symbol("csrf") @Symbol("csrf")
......
...@@ -41,7 +41,7 @@ import org.kohsuke.accmod.restrictions.NoExternalUse; ...@@ -41,7 +41,7 @@ import org.kohsuke.accmod.restrictions.NoExternalUse;
* Monitors enabled protocols and warns if an {@link AgentProtocol} is deprecated. * Monitors enabled protocols and warns if an {@link AgentProtocol} is deprecated.
* *
* @author Oleg Nenashev * @author Oleg Nenashev
* @since TODO * @since 2.75
* @see AgentProtocol * @see AgentProtocol
*/ */
@Extension @Extension
......
...@@ -46,7 +46,7 @@ import org.kohsuke.stapler.DataBoundConstructor; ...@@ -46,7 +46,7 @@ import org.kohsuke.stapler.DataBoundConstructor;
* See <a href="https://github.com/jenkinsci/remoting/blob/master/docs/workDir.md">Remoting Work Dir Documentation</a>. * See <a href="https://github.com/jenkinsci/remoting/blob/master/docs/workDir.md">Remoting Work Dir Documentation</a>.
* *
* @author Oleg Nenashev * @author Oleg Nenashev
* @since TODO * @since 2.72
*/ */
public class RemotingWorkDirSettings implements Describable<RemotingWorkDirSettings> { public class RemotingWorkDirSettings implements Describable<RemotingWorkDirSettings> {
......
...@@ -43,7 +43,7 @@ public class TimeDuration { ...@@ -43,7 +43,7 @@ public class TimeDuration {
/** /**
* Returns the duration of this instance in <em>seconds</em>. * Returns the duration of this instance in <em>seconds</em>.
* @since TODO * @since 2.82
*/ */
public int getTimeInSeconds() { public int getTimeInSeconds() {
return (int) (millis / 1000L); return (int) (millis / 1000L);
......
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册