提交 f3426ddf 编写于 作者: D Daniel Beck

Fix @since tags

上级 62eb3c52
......@@ -10,7 +10,7 @@ import java.util.List;
/**
* {@link CLICommand} that acts on a series of {@link Run}s.
* @since FIXME
* @since 2.62
*/
public abstract class RunRangeCommand extends CLICommand {
@Argument(metaVar="JOB",usage="Name of the job to build",required=true,index=0)
......
......@@ -40,7 +40,7 @@ import org.jenkinsci.Symbol;
*
* @author Kohsuke Kawaguchi
* @since 1.349 - produces search hyperlinks to the http://stacktrace.jenkins-ci.org service
* @since TODO - does nothing due to JENKINS-42861
* @since 2.56 - does nothing due to JENKINS-42861
* @deprecated This ConsoleNote used to provide hyperlinks to the
* <code>http://stacktrace.jenkins-ci.org/</code> service, which is dead now (JENKINS-42861).
* This console note does nothing right now.
......
......@@ -976,7 +976,7 @@ public /*transient*/ abstract class Computer extends Actionable implements Acces
* Gets the read-only snapshot view of all {@link Executor} instances including {@linkplain OneOffExecutor}s.
*
* @return the read-only snapshot view of all {@link Executor} instances including {@linkplain OneOffExecutor}s.
* @since TODO
* @since 2.55
*/
public List<Executor> getAllExecutors() {
List<Executor> result = new ArrayList<>(executors.size() + oneOffExecutors.size());
......
......@@ -1051,7 +1051,7 @@ public abstract class Job<JobT extends Job<JobT, RunT>, RunT extends Run<JobT, R
/**
* RSS feed for changes in this project.
*
* @since TODO
* @since 2.60
*/
public void doRssChangelog(StaplerRequest req, StaplerResponse rsp) throws IOException, ServletException {
class FeedItem {
......
......@@ -200,7 +200,7 @@ public class ItemListener implements ExtensionPoint {
* @param src the item being copied
* @param parent the proposed parent
* @throws Failure if the copy operation has been vetoed.
* @since TODO
* @since 2.51
*/
public static void checkBeforeCopy(final Item src, final ItemGroup parent) throws Failure {
for (ItemListener l : all()) {
......
......@@ -65,7 +65,7 @@ public class Tasks {
* @param t the {@link SubTask}.
* @return the {@link hudson.model.Item} associated with the {@link SubTask} or {@code null} if this
* {@link SubTask} is not associated with an {@link hudson.model.Item}
* @since TODO
* @since 2.55
*/
@CheckForNull
public static hudson.model.Item getItemOf(@Nonnull SubTask t) {
......
......@@ -328,7 +328,7 @@ public final class CronTab {
* This method modifies the given calendar and returns the same object.
*
* @throws RareOrImpossibleDateException if the date isn't hit in the 2 years after it indicates an impossible
* (e.g. Jun 31) date, or at least a date too rare to be useful. This addresses JENKINS-41864 and was added in TODO
* (e.g. Jun 31) date, or at least a date too rare to be useful. This addresses JENKINS-41864 and was added in 2.49
*/
public Calendar ceil(Calendar cal) {
Calendar twoYearsFuture = (Calendar) cal.clone();
......@@ -389,7 +389,7 @@ public final class CronTab {
* This method modifies the given calendar and returns the same object.
*
* @throws RareOrImpossibleDateException if the date isn't hit in the 2 years before it indicates an impossible
* (e.g. Jun 31) date, or at least a date too rare to be useful. This addresses JENKINS-41864 and was added in TODO
* (e.g. Jun 31) date, or at least a date too rare to be useful. This addresses JENKINS-41864 and was added in 2.49
*/
public Calendar floor(Calendar cal) {
Calendar twoYearsAgo = (Calendar) cal.clone();
......@@ -537,7 +537,7 @@ public final class CronTab {
* Returns the configured time zone, or null if none is configured
*
* @return the configured time zone, or null if none is configured
* @since TODO
* @since 2.54
*/
@CheckForNull public TimeZone getTimeZone() {
if (this.specTimezone == null) {
......
......@@ -527,7 +527,7 @@ public abstract class SCM implements Describable<SCM>, ExtensionPoint {
* are going to provide information about check out (like SVN revision number that was checked out), be prepared
* for the possibility that the check out hasn't happened yet.
*
* @since FIXME
* @since 2.60
*/
public void buildEnvironment(@Nonnull Run<?,?> build, @Nonnull Map<String,String> env) {
if (build instanceof AbstractBuild) {
......@@ -535,6 +535,9 @@ public abstract class SCM implements Describable<SCM>, ExtensionPoint {
}
}
/**
* @deprecated in favor of {@link #buildEnvironment(Run, Map)}.
*/
@Deprecated
public void buildEnvVars(AbstractBuild<?,?> build, Map<String, String> env) {
if (Util.isOverridden(SCM.class, getClass(), "buildEnvironment", Run.class, Map.class)) {
......
......@@ -80,7 +80,7 @@ import java.util.concurrent.Future;
*
* <h3>Views</h3>
*
* Since version TODO, Jenkins clouds are visualized in UI. Implementations can provide <tt>top</tt> or <tt>main</tt> view
* Since version 2.64, Jenkins clouds are visualized in UI. Implementations can provide <tt>top</tt> or <tt>main</tt> view
* to be presented at the top of the page or at the bottom respectively. In the middle, actions have their <tt>summary</tt>
* views displayed. Actions further contribute to <tt>sidepanel</tt> with <tt>box</tt> views. All mentioned views are
* optional to preserve backward compatibility.
......@@ -110,7 +110,7 @@ public abstract class Cloud extends Actionable implements ExtensionPoint, Descri
/**
* Get URL of the cloud.
*
* @since TODO
* @since 2.64
* @return Jenkins relative URL.
*/
public @Nonnull String getUrl() {
......
......@@ -48,7 +48,7 @@ import org.apache.tools.ant.util.DeweyDecimal;
* </dl>
*
* @author Stephen Connolly
* @since 24-Apr-2008 22:12:35
* @since 1.216-ish
* @see ComputerConnector
*/
public abstract class ComputerLauncher extends AbstractDescribableImpl<ComputerLauncher> implements ExtensionPoint {
......
......@@ -33,8 +33,8 @@ import java.io.ObjectStreamException;
/**
* Installs tool via script execution of Batch script.
* Inspired by "Command installer" from the Jenkins core.
* @since 0.1
*
* @since 1.549
*/
public class BatchCommandInstaller extends AbstractCommandInstaller {
......
......@@ -45,7 +45,7 @@ import java.util.List;
* Collection whose change is notified to the parent object for persistence.
*
* @author Kohsuke Kawaguchi
* @since 1.MULTISOURCE
* @since 1.333
*/
public class PersistedList<T> extends AbstractList<T> {
protected final CopyOnWriteList<T> data = new CopyOnWriteList<T>();
......
......@@ -23,7 +23,7 @@ import java.io.File;
*
* @author Kohsuke Kawaguchi
* @see FilePath
* @since 1.THU
* @since 1.587 / 1.580.1
*/
public abstract class FilePathFilter {
/**
......
......@@ -15,7 +15,7 @@ import java.util.concurrent.CopyOnWriteArrayList;
*
* @author Kohsuke Kawaguchi
* @see FilePath
* @since 1.THU
* @since 1.587 / 1.580.1
*/
class FilePathFilterAggregator extends FilePathFilter {
private final CopyOnWriteArrayList<Entry> all = new CopyOnWriteArrayList<Entry>();
......
......@@ -7,7 +7,7 @@ import org.jenkinsci.remoting.RoleChecker;
/**
* {@link FileCallable}s that are meant to be only used on the master.
*
* @since 1.THU
* @since 1.587 / 1.580.1
*/
public abstract class MasterToSlaveFileCallable<T> implements FileCallable<T> {
@Override
......
......@@ -7,7 +7,7 @@ import java.io.File;
* operations as a single string argument.
*
* @author Kohsuke Kawaguchi
* @since 1.THU
* @since 1.587 / 1.580.1
*/
public abstract class ReflectiveFilePathFilter extends FilePathFilter {
/**
......
......@@ -7,7 +7,7 @@ import org.jenkinsci.remoting.RoleChecker;
/**
* {@link FileCallable}s that can be executed on the master, sent by the agent.
*
* @since 1.THU
* @since 1.587 / 1.580.1
*/
public abstract class SlaveToMasterFileCallable<T> implements FileCallable<T> {
@Override
......
......@@ -2176,7 +2176,7 @@ public class Jenkins extends AbstractCIBase implements DirectlyModifiableTopLeve
/**
* Returns the enabled and activated administrative monitors.
* @since TODO
* @since 2.64
*/
public List<AdministrativeMonitor> getActiveAdministrativeMonitors() {
return administrativeMonitors.stream().filter(m -> m.isEnabled() && m.isActivated()).collect(Collectors.toList());
......
......@@ -41,7 +41,7 @@ import javax.annotation.concurrent.GuardedBy;
/**
* A {@link Queue.QueueDecisionHandler} that blocks items being deleted from entering the queue.
*
* @since TODO
* @since 2.55
*/
@Extension
public class ItemDeletion extends Queue.QueueDecisionHandler {
......
......@@ -48,7 +48,7 @@ import java.util.logging.Logger;
/**
* Allows a {@link Run} to provide {@link SCM}-related methods, such as providing changesets and culprits.
*
* @since FIXME
* @since 2.60
*/
public interface RunWithSCM<JobT extends Job<JobT, RunT>,
RunT extends Run<JobT, RunT> & RunWithSCM<JobT,RunT>> {
......
......@@ -13,7 +13,7 @@ import javax.annotation.Nullable;
* Intercepts the new creation of {@link Channel} and tweak its configuration.
*
* @author Kohsuke Kawaguchi
* @since 1.THU
* @since 1.587 / 1.580.1
*/
public abstract class ChannelConfigurator implements ExtensionPoint {
/**
......
......@@ -8,7 +8,7 @@ import org.jenkinsci.remoting.RoleChecker;
* Convenient {@link Callable} meant to be run on agent.
*
* @author Kohsuke Kawaguchi
* @since 1.THU
* @since 1.587 / 1.580.1
*/
public abstract class MasterToSlaveCallable<V, T extends Throwable> implements Callable<V,T> {
@Override
......
......@@ -8,7 +8,7 @@ import org.jenkinsci.remoting.RoleChecker;
* just as a convenient function that has parameterized return value and exception type.
*
* @author Kohsuke Kawaguchi
* @since 1.THU
* @since 1.587 / 1.580.1
*/
public abstract class NotReallyRoleSensitiveCallable<V,T extends Throwable> implements Callable<V,T> {
@Override
......
......@@ -12,7 +12,7 @@ import org.jenkinsci.remoting.Role;
* not have any role.
*
* @author Kohsuke Kawaguchi
* @since 1.THU
* @since 1.587 / 1.580.1
*/
public class Roles {
/**
......
......@@ -8,7 +8,7 @@ import org.jenkinsci.remoting.RoleChecker;
* Convenient {@link Callable} that are meant to run on the master (sent by agent/CLI/etc).
*
* @author Kohsuke Kawaguchi
* @since 1.THU
* @since 1.587 / 1.580.1
*/
public abstract class SlaveToMasterCallable<V, T extends Throwable> implements Callable<V,T> {
@Override
......
......@@ -18,7 +18,7 @@ import java.io.IOException;
* Report any rejected {@link Callable}s and {@link FilePath} executions and allow
* admins to whitelist them.
*
* @since 1.THU
* @since 1.587 / 1.580.1
* @author Kohsuke Kawaguchi
*/
@Extension @Symbol("slaveToMasterAccessControl")
......
......@@ -17,7 +17,7 @@ import java.io.File;
* This class is just a glue, and the real logic happens inside {@link AdminWhitelistRule}
*
* @author Kohsuke Kawaguchi
* @since 1.THU
* @since 1.587 / 1.580.1
*/
public class AdminFilePathFilter extends ReflectiveFilePathFilter {
......
......@@ -22,7 +22,7 @@ import java.util.logging.Logger;
* Inspects {@link Callable}s that run on the master.
*
* @author Kohsuke Kawaguchi
* @since 1.THU
* @since 1.587 / 1.580.1
*/
@Restricted(NoExternalUse.class) // used implicitly via listener
public class CallableDirectionChecker extends RoleChecker {
......
......@@ -18,7 +18,7 @@ import java.util.Collection;
* {@link Callable#checkRoles(RoleChecker)} method.
*
* @author Kohsuke Kawaguchi
* @since 1.THU
* @since 1.587 / 1.580.1
*/
public abstract class CallableWhitelist implements ExtensionPoint {
/**
......
......@@ -12,7 +12,7 @@ import org.kohsuke.stapler.StaplerRequest;
* Exposes {@link AdminWhitelistRule#masterKillSwitch} to the admin.
*
* @author Kohsuke Kawaguchi
* @since 1.THU
* @since 1.587 / 1.580.1
*/
@Extension
public class MasterKillSwitchConfiguration extends GlobalConfiguration {
......
......@@ -14,7 +14,7 @@ import java.io.IOException;
* If {@link AdminWhitelistRule#masterKillSwitch} is on, warn the user.
*
* @author Kohsuke Kawaguchi
* @since 1.THU
* @since 1.587 / 1.580.1
*/
@Extension
public class MasterKillSwitchWarning extends AdministrativeMonitor {
......
......@@ -25,7 +25,7 @@ import org.kohsuke.accmod.restrictions.NoExternalUse;
*
* <p>@see {@link org.jenkinsci.remoting.engine.JnlpProtocol3Handler} for more details.
*
* @since 1.XXX
* @since 1.653
*/
@Deprecated
@Extension
......
......@@ -58,8 +58,8 @@ import org.jenkinsci.remoting.protocol.cert.PublicKeyMatchingX509ExtendedTrustMa
*
* <p>@see {@link org.jenkinsci.remoting.engine.JnlpProtocol4Handler} for more details.
*
* @since 2.27 available as the experimental protocol
* @since TODO enabled by default
* @since 2.27 available as experimental protocol
* @since 2.41 enabled by default
*/
@Extension
public class JnlpSlaveAgentProtocol4 extends AgentProtocol {
......
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册