提交 5cd5a198 编写于 作者: S Seiji Sogabe

Merge pull request #860 from MarkEWaite/javadoc-fixes-1

Javadoc fixes for Jenkins core
...@@ -38,7 +38,7 @@ import java.util.List; ...@@ -38,7 +38,7 @@ import java.util.List;
* some fails, etc. * some fails, etc.
* *
* @author Kohsuke Kawaguchi * @author Kohsuke Kawaguchi
* @sicne 1.456 * @since 1.456
*/ */
public abstract class MatrixExecutionStrategy extends AbstractDescribableImpl<MatrixExecutionStrategy> implements ExtensionPoint { public abstract class MatrixExecutionStrategy extends AbstractDescribableImpl<MatrixExecutionStrategy> implements ExtensionPoint {
public Result run(MatrixBuildExecution execution) throws InterruptedException, IOException { public Result run(MatrixBuildExecution execution) throws InterruptedException, IOException {
......
...@@ -467,7 +467,7 @@ public abstract class Node extends AbstractModelObject implements Reconfigurable ...@@ -467,7 +467,7 @@ public abstract class Node extends AbstractModelObject implements Reconfigurable
* *
* @return * @return
* always non-null. * always non-null.
* @sine 1.522 * @since 1.522
*/ */
public abstract Callable<ClockDifference,IOException> getClockDifferenceCallable(); public abstract Callable<ClockDifference,IOException> getClockDifferenceCallable();
......
...@@ -463,7 +463,7 @@ public abstract class Run <JobT extends Job<JobT,RunT>,RunT extends Run<JobT,Run ...@@ -463,7 +463,7 @@ public abstract class Run <JobT extends Job<JobT,RunT>,RunT extends Run<JobT,Run
* *
* This method looks for {@link Executor} who's {@linkplain Executor#getCurrentExecutable() assigned to this build}, * This method looks for {@link Executor} who's {@linkplain Executor#getCurrentExecutable() assigned to this build},
* and because of that this might not be necessarily in sync with the return value of {@link #isBuilding()} &mdash; * and because of that this might not be necessarily in sync with the return value of {@link #isBuilding()} &mdash;
* an executor holds on to {@lnk Run} some more time even after the build is finished (for example to * an executor holds on to {@link Run} some more time even after the build is finished (for example to
* perform {@linkplain State#POST_PRODUCTION post-production processing}.) * perform {@linkplain State#POST_PRODUCTION post-production processing}.)
*/ */
@Exported @Exported
......
...@@ -60,7 +60,7 @@ public abstract class TransientComputerActionFactory implements ExtensionPoint { ...@@ -60,7 +60,7 @@ public abstract class TransientComputerActionFactory implements ExtensionPoint {
/** /**
* Creates {@link Action)s for a node, using all registered {@link TransientComputerActionFactory }s. * Creates {@link Action}s for a node, using all registered {@link TransientComputerActionFactory}s.
*/ */
public static List<Action> createAllFor(Computer target) { public static List<Action> createAllFor(Computer target) {
List<Action> result = new ArrayList<Action>(); List<Action> result = new ArrayList<Action>();
......
...@@ -30,7 +30,7 @@ public abstract class TransientViewActionFactory implements ExtensionPoint { ...@@ -30,7 +30,7 @@ public abstract class TransientViewActionFactory implements ExtensionPoint {
} }
/** /**
* Creates {@link Action)s for a view, using all registered {@link TransientViewActionFactory}s. * Creates {@link Action}s for a view, using all registered {@link TransientViewActionFactory}s.
*/ */
public static List<Action> createAllFor(View v) { public static List<Action> createAllFor(View v) {
List<Action> result = new ArrayList<Action>(); List<Action> result = new ArrayList<Action>();
......
...@@ -1193,8 +1193,6 @@ public class UpdateCenter extends AbstractModelObject implements Saveable, OnMas ...@@ -1193,8 +1193,6 @@ public class UpdateCenter extends AbstractModelObject implements Saveable, OnMas
/** /**
* Indicates that the installation was successful but a restart is needed. * Indicates that the installation was successful but a restart is needed.
*
* @see
*/ */
public class SuccessButRequiresRestart extends Success { public class SuccessButRequiresRestart extends Success {
private final Localizable message; private final Localizable message;
......
...@@ -779,7 +779,7 @@ public abstract class View extends AbstractModelObject implements AccessControll ...@@ -779,7 +779,7 @@ public abstract class View extends AbstractModelObject implements AccessControll
private final String iconSize; private final String iconSize;
public final ModelObject parent; public final ModelObject parent;
/** @see Jenkins#getAsynchPeople} */ /** @see Jenkins#getAsynchPeople */
public AsynchPeople(Jenkins parent) { public AsynchPeople(Jenkins parent) {
this.parent = parent; this.parent = parent;
items = parent.getItems(); items = parent.getItems();
......
...@@ -41,7 +41,7 @@ import java.io.IOException; ...@@ -41,7 +41,7 @@ import java.io.IOException;
* Checks the swap space availability. * Checks the swap space availability.
* *
* @author Kohsuke Kawaguchi * @author Kohsuke Kawaguchi
* @sine 1.233 * @since 1.233
*/ */
public class SwapSpaceMonitor extends NodeMonitor { public class SwapSpaceMonitor extends NodeMonitor {
/** /**
......
...@@ -3,7 +3,7 @@ package hudson.search; ...@@ -3,7 +3,7 @@ package hudson.search;
import java.util.List; import java.util.List;
/** /**
* @author: <a hef="mailto:nicolas.deloof@gmail.com">Nicolas De Loof</a> * @author <a hef="mailto:nicolas.deloof@gmail.com">Nicolas De Loof</a>
*/ */
public interface SearchResult extends List<SuggestedItem> { public interface SearchResult extends List<SuggestedItem> {
......
...@@ -44,7 +44,7 @@ import org.jvnet.localizer.Localizable; ...@@ -44,7 +44,7 @@ import org.jvnet.localizer.Localizable;
* Each permission is represented by a specific instance of {@link Permission}. * Each permission is represented by a specific instance of {@link Permission}.
* *
* @author Kohsuke Kawaguchi * @author Kohsuke Kawaguchi
* @see https://wiki.jenkins-ci.org/display/JENKINS/Making+your+plugin+behave+in+secured+Jenkins * @see <a href="https://wiki.jenkins-ci.org/display/JENKINS/Making+your+plugin+behave+in+secured+Jenkins">Plugins in secured Jenkins</a>
*/ */
public final class Permission { public final class Permission {
......
...@@ -37,7 +37,7 @@ import org.kohsuke.stapler.StaplerResponse; ...@@ -37,7 +37,7 @@ import org.kohsuke.stapler.StaplerResponse;
* forged by a third party. * forged by a third party.
* *
* @author dty * @author dty
* @see http://en.wikipedia.org/wiki/XSRF * @see <a href="http://en.wikipedia.org/wiki/XSRF">Wikipedia: Cross site request forgery</a>
*/ */
@ExportedBean @ExportedBean
public abstract class CrumbIssuer implements Describable<CrumbIssuer>, ExtensionPoint { public abstract class CrumbIssuer implements Describable<CrumbIssuer>, ExtensionPoint {
......
...@@ -38,7 +38,7 @@ import static java.util.Collections.emptyList; ...@@ -38,7 +38,7 @@ import static java.util.Collections.emptyList;
* language or implementation specifics. * language or implementation specifics.
* Subclasses must add @Exported annotation to the fields they want to export. * Subclasses must add @Exported annotation to the fields they want to export.
* *
* @sine 1.343 * @since 1.343
*/ */
public abstract class TestResult extends TestObject { public abstract class TestResult extends TestObject {
......
...@@ -343,7 +343,7 @@ public class XStream2 extends XStream { ...@@ -343,7 +343,7 @@ public class XStream2 extends XStream {
* callback code just after a type is unmarshalled by RobustReflectionConverter. * callback code just after a type is unmarshalled by RobustReflectionConverter.
* Example: <pre> public static class ConverterImpl extends XStream2.PassthruConverter&lt;MyType&gt; { * Example: <pre> public static class ConverterImpl extends XStream2.PassthruConverter&lt;MyType&gt; {
* public ConverterImpl(XStream2 xstream) { super(xstream); } * public ConverterImpl(XStream2 xstream) { super(xstream); }
* @Override protected void callback(MyType obj, UnmarshallingContext context) { * {@literal @}Override protected void callback(MyType obj, UnmarshallingContext context) {
* ... * ...
* </pre> * </pre>
*/ */
......
...@@ -51,7 +51,7 @@ typedef struct _SHELLEXECUTEINFO { ...@@ -51,7 +51,7 @@ typedef struct _SHELLEXECUTEINFO {
} SHELLEXECUTEINFO, *LPSHELLEXECUTEINFO; } SHELLEXECUTEINFO, *LPSHELLEXECUTEINFO;
* </pre> * </pre>
* @author Kohsuke Kawaguchi * @author Kohsuke Kawaguchi
* @see MSDN: http://msdn.microsoft.com/en-us/library/bb759784(v=VS.85).aspx * @see <a href="http://msdn.microsoft.com/en-us/library/bb759784(v=VS.85).aspx">MSDN: SHELLEXECUTEINFO</a>
*/ */
public class SHELLEXECUTEINFO extends Structure { public class SHELLEXECUTEINFO extends Structure {
public int cbSize = size(); public int cbSize = size();
......
...@@ -235,7 +235,7 @@ public class XStreamDOM { ...@@ -235,7 +235,7 @@ public class XStreamDOM {
/** /**
* Returns a new {@link HierarchicalStreamWriter} for marshalling objects into {@link XStreamDOM}. * Returns a new {@link HierarchicalStreamWriter} for marshalling objects into {@link XStreamDOM}.
* After the writer receives the calls, call {@Link WriterImpl#getOutput()} to obtain the populated tree. * After the writer receives the calls, call {@link WriterImpl#getOutput()} to obtain the populated tree.
*/ */
public static WriterImpl newWriter() { public static WriterImpl newWriter() {
return new WriterImpl(); return new WriterImpl();
......
...@@ -10,7 +10,7 @@ import jenkins.model.Jenkins; ...@@ -10,7 +10,7 @@ import jenkins.model.Jenkins;
* A plugin may remove this from {@link Jenkins#getWidgets()} and swap in their own. * A plugin may remove this from {@link Jenkins#getWidgets()} and swap in their own.
* *
* @author Kohsuke Kawaguchi * @author Kohsuke Kawaguchi
* @sine 1.514 * @since 1.514
*/ */
@Extension(ordinal=200) // historically this was the top most widget @Extension(ordinal=200) // historically this was the top most widget
public class BuildQueueWidget extends Widget { public class BuildQueueWidget extends Widget {
......
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册