Skip to content

Commit

Permalink
Correct broken javadoc tag usage
Browse files Browse the repository at this point in the history
  • Loading branch information
chadlwilson committed Sep 17, 2023
1 parent 3d06dbd commit 4a3012e
Show file tree
Hide file tree
Showing 219 changed files with 292 additions and 359 deletions.
Expand Up @@ -18,7 +18,7 @@
import com.thoughtworks.cruise.agent.common.launcher.AgentLauncher;

/**
* @understands how to create a launcher object
* Understands how to create a launcher object
*/
public interface AgentLauncherCreator extends AutoCloseable {
AgentLauncher createLauncher();
Expand Down
Expand Up @@ -16,7 +16,7 @@
package com.thoughtworks.cruise.agent.common.launcher;

/**
* @understands starting agent with lock file management
* Understands starting agent with lock file management
*/
public interface AgentLauncher {

Expand Down
Expand Up @@ -42,7 +42,7 @@
import static java.lang.String.format;

/**
* @understands runtime and configuration information of a builder machine
* Understands runtime and configuration information of a builder machine
*/
public class AgentInstance implements Comparable<AgentInstance> {
private final AgentType agentType;
Expand Down
Expand Up @@ -16,7 +16,7 @@
package com.thoughtworks.go.domain;

/**
* @understands live information about an agent
* Understands live information about an agent
*/
public enum AgentRuntimeStatus {
Idle, Building, LostContact, Missing, Cancelled, Unknown;
Expand Down
Expand Up @@ -18,7 +18,7 @@
import java.io.Serializable;

/**
* @understands different states agent can be in
* Understands different states agent can be in
*/
public enum AgentStatus implements Comparable<AgentStatus>, Serializable {
Pending("Pending", AgentConfigStatus.Pending, AgentRuntimeStatus.Unknown),
Expand Down
Expand Up @@ -18,7 +18,7 @@
import com.thoughtworks.go.domain.exception.IllegalArtifactLocationException;

/**
* @understands artifact url for jobs
* Understands artifact url for jobs
*/
public interface ArtifactUrlReader {
String findArtifactRoot(JobIdentifier identifier) throws IllegalArtifactLocationException;
Expand Down
Expand Up @@ -18,7 +18,7 @@
import com.thoughtworks.go.util.FileSizeUtils;

/**
* @understands storage measurement
* Understands storage measurement
*/
public class DiskSpace implements Comparable<DiskSpace> {
private final Long space;
Expand Down
Expand Up @@ -16,7 +16,7 @@
package com.thoughtworks.go.domain;

/**
* @understands loading job plan for job
* Understands loading job plan for job
*/
public interface JobPlanLoader {
JobPlan loadOriginalJobPlan(JobIdentifier jobId);
Expand Down
Expand Up @@ -15,16 +15,16 @@
*/
package com.thoughtworks.go.domain;

import java.util.List;

import com.thoughtworks.go.config.CaseInsensitiveString;
import com.thoughtworks.go.config.materials.dependency.DependencyMaterial;
import com.thoughtworks.go.domain.materials.Material;
import com.thoughtworks.go.domain.materials.Modification;
import com.thoughtworks.go.domain.materials.Modifications;
import com.thoughtworks.go.config.materials.dependency.DependencyMaterial;

import java.util.List;

/**
* @understands pipeline instance's reference to modifications
* Understands pipeline instance's reference to modifications
*/
public class PipelineMaterialRevision extends PersistentObject {
private String name;
Expand Down
Expand Up @@ -15,16 +15,12 @@
*/
package com.thoughtworks.go.domain;

import java.util.Date;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.TreeSet;
import java.util.*;

import static com.thoughtworks.go.util.ExceptionUtils.bomb;

/**
* @understands a pipeline which can be compared based on its material checkin (natural) order
* Understands a pipeline which can be compared based on its material checkin (natural) order
*/
public class PipelineTimelineEntry implements Comparable {
private final String pipelineName;
Expand Down
Expand Up @@ -18,7 +18,7 @@
import org.dom4j.Document;

/**
* @understands interface to get xml representation of an object
* Understands interface to get xml representation of an object
*/
public interface XmlRepresentable {
Document toXml(XmlWriterContext writerContext);
Expand Down
Expand Up @@ -24,7 +24,7 @@
import static org.apache.commons.lang3.StringUtils.*;

/**
* @understands objects required by domain entities to render xml representation
* Understands objects required by domain entities to render xml representation
*/
public class XmlWriterContext {
private final String baseUrl;
Expand Down
Expand Up @@ -22,7 +22,7 @@
import static org.apache.commons.lang3.StringUtils.join;

/**
* @understands converting the localized message for a given key
* Understands converting the localized message for a given key
*/
public abstract class LocalizedMessage {

Expand Down
Expand Up @@ -25,7 +25,7 @@
import java.util.Set;

/**
* @understands What values are selected on multiple agents
* Understands What values are selected on multiple agents
*/
public class TriStateSelection implements Comparable<TriStateSelection> {
private String value;
Expand Down
Expand Up @@ -19,7 +19,7 @@
import com.thoughtworks.go.domain.materials.Revision;

/**
* @understands empty pipeline instance for scenarios where there is no instance to be shown
* Understands empty pipeline instance for scenarios where there is no instance to be shown
*/
public class EmptyPipelineInstanceModel extends PipelineInstanceModel {
EmptyPipelineInstanceModel(String pipelineName, BuildCause withEmptyModifications, StageInstanceModels stageHistory) {
Expand Down
Expand Up @@ -18,7 +18,7 @@
import java.util.List;

/**
* @understands history of pipelines run within an environment
* Understands history of pipelines run within an environment
*/
public class Environment {
private final String name;
Expand Down
Expand Up @@ -15,13 +15,13 @@
*/
package com.thoughtworks.go.presentation.pipelinehistory;

import com.thoughtworks.go.domain.PipelinePauseInfo;

import java.util.ArrayList;
import java.util.List;

import com.thoughtworks.go.domain.PipelinePauseInfo;

/**
* @understands group level aggregation of active pipelines
* Understands group level aggregation of active pipelines
*/
public class PipelineGroupModel {
private String name;
Expand Down
Expand Up @@ -475,7 +475,7 @@ public boolean isBisect() {
}

public static boolean isBisect(double naturalOrder) {
return naturalOrder - new Double(naturalOrder).intValue() > 0;//TODO: may be we should be using long, as int can lead to truncation
return naturalOrder - Double.valueOf(naturalOrder).longValue() > 0;
}

public TrackingTool getTrackingTool() {
Expand Down
Expand Up @@ -22,7 +22,7 @@
import java.util.Date;

/**
* @understands a pipeline that is preparing to schedule
* Understands a pipeline that is preparing to schedule
*/
public class PreparingToScheduleInstance extends PipelineInstanceModel {

Expand Down
Expand Up @@ -21,7 +21,7 @@
import com.thoughtworks.go.domain.StageState;

/**
* @understands stage details to allow rendering of an entry in stage-history page
* Understands stage details to allow rendering of an entry in stage-history page
*/
public class StageHistoryEntry extends PersistentObject {
private StageIdentifier identifier;
Expand Down
Expand Up @@ -15,12 +15,12 @@
*/
package com.thoughtworks.go.presentation.pipelinehistory;

import java.util.List;

import com.thoughtworks.go.server.util.Pagination;

import java.util.List;

/**
* @understands a single page of the stagehistory
* Understands a single page of the stagehistory
*/
public class StageHistoryPage {
private List<StageHistoryEntry> stages;
Expand Down
Expand Up @@ -16,9 +16,8 @@
package com.thoughtworks.go.server.service;

/**
* @understands The situation when an agent does not have cookie set has the same UUID as an other agent and does not have a cookie.
* understands The situation when an agent does not have cookie set has the same UUID as an other agent and does not have a cookie.
*/

public class AgentNoCookieSetException extends RuntimeException {

public AgentNoCookieSetException(String message) {
Expand Down
Expand Up @@ -16,7 +16,7 @@
package com.thoughtworks.go.server.service;

/**
* @understands The situation when an agent has the same UUID as an other agent and does not have a cookie.
* Understands The situation when an agent has the same UUID as an other agent and does not have a cookie.
*/
public class AgentWithDuplicateUUIDException extends RuntimeException {

Expand Down
Expand Up @@ -17,9 +17,6 @@

import com.thoughtworks.go.domain.buildcause.BuildCause;

/**
* @understands: UpstreamPipelineResolver
*/
public interface UpstreamPipelineResolver {
BuildCause buildCauseFor(String pipelineName, int pipelineCounter);
}
Expand Up @@ -21,7 +21,7 @@
import static org.apache.http.HttpStatus.SC_FORBIDDEN;

/**
* @understands localized operation result for http
* Understands localized operation result for http
*/
public class HttpLocalizedOperationResult implements LocalizedOperationResult {
private String message;
Expand Down
Expand Up @@ -22,7 +22,7 @@
import static org.apache.http.HttpStatus.SC_FORBIDDEN;

/**
* @understands how to turn the problems that can occur during api calls into human-readable form and http codes
* Understands how to turn the problems that can occur during api calls into human-readable form and http codes
*/
public class HttpOperationResult implements OperationResult {

Expand Down
Expand Up @@ -18,7 +18,7 @@
import com.thoughtworks.go.serverhealth.HealthStateType;

/**
* @understands the current status of a given task.
* Understands the current status of a given task.
*/
public interface LocalizedOperationResult {

Expand Down
Expand Up @@ -19,7 +19,7 @@
import com.thoughtworks.go.serverhealth.ServerHealthState;

/**
* @understands the current status of a given task.
* Understands the current status of a given task.
*/
public interface OperationResult {

Expand Down
Expand Up @@ -19,7 +19,7 @@
import com.thoughtworks.go.serverhealth.ServerHealthState;

/**
* @understands the current status of the Server Health.
* Understands the current status of the Server Health.
*/
public class ServerHealthStateOperationResult implements OperationResult {
private ServerHealthState lastHealthState = null;
Expand Down
Expand Up @@ -15,12 +15,12 @@
*/
package com.thoughtworks.go.server.util;

import java.util.UUID;

import org.springframework.stereotype.Component;

import java.util.UUID;

/**
* @understands generating random uuid
* Understands generating random uuid
*/
@Component
public class UuidGenerator {
Expand Down
Expand Up @@ -15,12 +15,12 @@
*/
package com.thoughtworks.go.serverhealth;

import java.util.List;

import com.thoughtworks.go.domain.BaseCollection;

import java.util.List;

/**
* @understands a collection of server health states
* Understands a collection of server health states
*/
public class ServerHealthStates extends BaseCollection<ServerHealthState> {
public ServerHealthStates(List<ServerHealthState> serverHealthStates) {
Expand Down
Expand Up @@ -20,7 +20,7 @@
import org.slf4j.LoggerFactory;

/**
* @understands handling subprocesses
* Understands handling subprocesses
*/
public class SubprocessLogger implements Runnable {
private CurrentProcess currentProcess;
Expand Down
Expand Up @@ -29,9 +29,6 @@
import static org.hamcrest.Matchers.hasItem;
import static org.hamcrest.Matchers.is;

/**
* @understands
*/
public class DirectoryEntriesTest {

@Test
Expand Down
Expand Up @@ -56,7 +56,7 @@
import static java.util.stream.Collectors.toMap;

/**
* @understands the configuration for cruise
* Understands the configuration for cruise
*/
@ConfigTag("cruise")
public class BasicCruiseConfig implements CruiseConfig {
Expand Down
Expand Up @@ -29,7 +29,7 @@
import static java.util.stream.Collectors.toCollection;

/**
* @understands the current persistent information related to a logical grouping of machines
* Understands the current persistent information related to a logical grouping of machines
*/
@ConfigTag("environment")
public class BasicEnvironmentConfig implements EnvironmentConfig {
Expand Down
Expand Up @@ -22,7 +22,7 @@
import static java.lang.annotation.RetentionPolicy.RUNTIME;

/**
* @understands mapping cruise-config attribute mapping to domain object
* Understands mapping cruise-config attribute mapping to domain object
*/
@Retention(RUNTIME)
@Target(TYPE)
Expand Down
Expand Up @@ -15,14 +15,14 @@
*/
package com.thoughtworks.go.config;

import java.lang.reflect.Constructor;

import com.thoughtworks.go.security.GoCipher;

import java.lang.reflect.Constructor;

import static com.thoughtworks.go.util.ExceptionUtils.bomb;

/**
* @understands creating instance of a config element class
* Understands creating instance of a config element class
*/
public class ConfigElementInstantiator {
public static <T> T instantiateConfigElement(GoCipher goCipher, Class<T> toGenerate) {
Expand Down

0 comments on commit 4a3012e

Please sign in to comment.