From 4a3012e69503ec93af3b7790e6167dcbc5fb2246 Mon Sep 17 00:00:00 2001 From: Chad Wilson Date: Sat, 16 Sep 2023 23:25:36 +0800 Subject: [PATCH] Correct broken javadoc tag usage --- .../go/agent/bootstrapper/AgentLauncherCreator.java | 2 +- .../cruise/agent/common/launcher/AgentLauncher.java | 2 +- .../com/thoughtworks/go/domain/AgentInstance.java | 2 +- .../thoughtworks/go/domain/AgentRuntimeStatus.java | 2 +- .../java/com/thoughtworks/go/domain/AgentStatus.java | 2 +- .../thoughtworks/go/domain/ArtifactUrlReader.java | 2 +- .../java/com/thoughtworks/go/domain/DiskSpace.java | 2 +- .../com/thoughtworks/go/domain/JobPlanLoader.java | 2 +- .../go/domain/PipelineMaterialRevision.java | 8 ++++---- .../go/domain/PipelineTimelineEntry.java | 8 ++------ .../com/thoughtworks/go/domain/XmlRepresentable.java | 2 +- .../com/thoughtworks/go/domain/XmlWriterContext.java | 2 +- .../com/thoughtworks/go/i18n/LocalizedMessage.java | 2 +- .../go/presentation/TriStateSelection.java | 2 +- .../pipelinehistory/EmptyPipelineInstanceModel.java | 2 +- .../go/presentation/pipelinehistory/Environment.java | 2 +- .../pipelinehistory/PipelineGroupModel.java | 6 +++--- .../pipelinehistory/PipelineInstanceModel.java | 2 +- .../pipelinehistory/PreparingToScheduleInstance.java | 2 +- .../pipelinehistory/StageHistoryEntry.java | 2 +- .../pipelinehistory/StageHistoryPage.java | 6 +++--- .../go/server/service/AgentNoCookieSetException.java | 3 +-- .../service/AgentWithDuplicateUUIDException.java | 2 +- .../go/server/service/UpstreamPipelineResolver.java | 3 --- .../service/result/HttpLocalizedOperationResult.java | 2 +- .../server/service/result/HttpOperationResult.java | 2 +- .../service/result/LocalizedOperationResult.java | 2 +- .../go/server/service/result/OperationResult.java | 2 +- .../result/ServerHealthStateOperationResult.java | 2 +- .../thoughtworks/go/server/util/UuidGenerator.java | 6 +++--- .../go/serverhealth/ServerHealthStates.java | 6 +++--- .../com/thoughtworks/go/util/SubprocessLogger.java | 2 +- .../thoughtworks/go/domain/DirectoryEntriesTest.java | 3 --- .../thoughtworks/go/config/BasicCruiseConfig.java | 2 +- .../go/config/BasicEnvironmentConfig.java | 2 +- .../thoughtworks/go/config/ConfigAttributeValue.java | 2 +- .../go/config/ConfigElementInstantiator.java | 6 +++--- .../go/config/ConfigSaveValidationContext.java | 2 +- .../com/thoughtworks/go/config/CruiseConfig.java | 7 +++++-- .../go/config/EncryptedVariableValueConfig.java | 2 +- .../go/config/EnvironmentAgentConfig.java | 2 +- .../go/config/EnvironmentAgentsConfig.java | 2 +- .../thoughtworks/go/config/EnvironmentConfig.java | 2 +- .../go/config/EnvironmentPipelineConfig.java | 6 +++--- .../go/config/EnvironmentPipelinesConfig.java | 2 +- .../go/config/EnvironmentVariableConfig.java | 2 +- .../go/config/EnvironmentVariablesConfig.java | 2 +- .../thoughtworks/go/config/EnvironmentsConfig.java | 2 +- .../thoughtworks/go/config/GoConfigGraphWalker.java | 6 +++--- .../thoughtworks/go/config/GoConfigPreprocessor.java | 2 +- .../java/com/thoughtworks/go/config/JobConfig.java | 2 +- .../java/com/thoughtworks/go/config/MqlCriteria.java | 6 +++--- .../thoughtworks/go/config/ParamsAttributeAware.java | 3 --- .../com/thoughtworks/go/config/PipelineConfig.java | 2 +- .../go/config/PipelineTemplateConfig.java | 3 +-- .../java/com/thoughtworks/go/config/StageConfig.java | 2 +- .../go/config/TemplateExpansionPreprocessor.java | 2 +- .../thoughtworks/go/config/TemplateToPipelines.java | 6 +++--- .../com/thoughtworks/go/config/TemplatesConfig.java | 2 +- .../java/com/thoughtworks/go/config/TimerConfig.java | 2 +- .../thoughtworks/go/config/ValidationErrorKey.java | 2 +- .../thoughtworks/go/config/VariableValueConfig.java | 2 +- .../go/config/materials/AbstractMaterialConfig.java | 2 +- .../go/config/materials/ScmMaterialConfig.java | 2 +- .../go/config/merge/MergeConfigOrigin.java | 2 +- .../go/config/merge/MergePipelineConfigs.java | 2 +- .../go/config/pluggabletask/PluggableTask.java | 7 +++++-- .../config/preprocessor/ConfigParamPreprocessor.java | 2 +- .../go/config/preprocessor/ParamHandlerFactory.java | 2 +- .../preprocessor/ParamReferenceCollectorFactory.java | 6 +++--- .../go/config/preprocessor/ParamScope.java | 3 --- .../ParamSubstitutionHandlerFactory.java | 2 +- .../config/preprocessor/SkipParameterResolution.java | 4 ++-- .../ConfigElementImplementationRegistry.java | 2 +- .../go/config/registry/ConfigElementRegistry.java | 3 --- .../go/config/registry/PluginNamespace.java | 6 +++--- .../thoughtworks/go/config/remote/ConfigOrigin.java | 2 +- .../go/config/remote/FileConfigOrigin.java | 2 +- .../go/config/remote/RepoConfigOrigin.java | 2 +- .../validation/ServerIdImmutabilityValidator.java | 2 +- .../TokenGenerationKeyImmutabilityValidator.java | 2 +- .../thoughtworks/go/domain/AgentConfigStatus.java | 2 +- .../go/domain/EnvironmentPipelineMatcher.java | 6 +++--- .../go/domain/EnvironmentPipelineMatchers.java | 2 +- .../java/com/thoughtworks/go/domain/IpAddress.java | 2 +- .../go/domain/KillAllChildProcessTask.java | 8 ++++---- .../thoughtworks/go/plugins/GoPluginManifest.java | 7 ++----- .../thoughtworks/go/plugins/PluginExtensions.java | 6 +++--- .../presentation/BuiltinTaskViewModelFactory.java | 4 ++-- .../presentation/PluggableViewModelFactory.java | 2 +- .../thoughtworks/go/presentation/TaskViewModel.java | 2 +- .../com/thoughtworks/go/service/TaskFactory.java | 3 --- .../go/util/command/EnvironmentVariableContext.java | 2 +- .../go/config/domain/VariableValueConfigTest.java | 5 +---- .../com/thoughtworks/go/plugins/PluginTestUtil.java | 9 +++------ .../thoughtworks/go/config/GoConfigMigration.java | 2 +- .../exceptions/ConfigFileHasChangedException.java | 2 +- .../presentation/PluggableTaskViewModelFactory.java | 2 +- .../thoughtworks/go/service/ConfigRepository.java | 2 +- .../go/config/serialization/CruiseConfigTest.java | 5 +---- .../com/thoughtworks/go/agent/DevelopmentAgent.java | 2 +- .../thoughtworks/go/server/DevelopmentServer.java | 2 +- .../go/config/materials/AbstractMaterial.java | 2 +- .../go/config/materials/ScmMaterial.java | 2 +- .../config/materials/SubprocessExecutionContext.java | 2 +- .../go/config/materials/mercurial/HgMaterial.java | 2 +- .../go/config/materials/svn/SvnMaterial.java | 2 +- .../go/domain/CannotScheduleException.java | 2 +- .../go/domain/DefaultSchedulingContext.java | 2 +- .../java/com/thoughtworks/go/domain/JobPlan.java | 2 +- .../java/com/thoughtworks/go/domain/JobType.java | 2 +- .../java/com/thoughtworks/go/domain/RunDuration.java | 2 +- .../thoughtworks/go/domain/RunMultipleInstance.java | 2 +- .../com/thoughtworks/go/domain/RunOnAllAgents.java | 2 +- .../thoughtworks/go/domain/SchedulingContext.java | 2 +- .../thoughtworks/go/domain/SingleJobInstance.java | 8 ++------ .../go/domain/buildcause/BuildCause.java | 2 +- .../go/domain/buildcause/BuildTrigger.java | 6 +++--- .../go/domain/materials/MatchedRevision.java | 2 +- .../go/domain/materials/NullRevision.java | 2 +- .../thoughtworks/go/domain/materials/SCMCommand.java | 3 --- .../go/domain/materials/tfs/TfsCommandFactory.java | 2 +- .../com/thoughtworks/go/config/CachedGoConfig.java | 2 +- .../thoughtworks/go/config/ConfigModifyingUser.java | 2 +- .../java/com/thoughtworks/go/config/GoConfigDao.java | 2 +- .../go/config/InvalidConfigMessageRemover.java | 2 +- .../java/com/thoughtworks/go/config/UserAware.java | 3 --- .../go/domain/activity/JobStatusCache.java | 2 +- .../java/com/thoughtworks/go/domain/feed/Author.java | 2 +- .../com/thoughtworks/go/domain/feed/FeedEntries.java | 2 +- .../com/thoughtworks/go/domain/feed/FeedEntry.java | 2 +- .../go/domain/feed/stage/StageFeedEntry.java | 2 +- .../thoughtworks/go/server/cache/ArtifactCache.java | 2 +- .../com/thoughtworks/go/server/cache/GoCache.java | 2 +- .../thoughtworks/go/server/dao/JobInstanceDao.java | 2 +- .../server/dao/LocalDependencyMaterialSourceDao.java | 8 ++++---- .../VariableValueConfigTypeHandlerCallback.java | 2 +- .../go/server/domain/JobDurationStrategy.java | 2 +- .../server/domain/PipelineConfigDependencyGraph.java | 2 +- .../go/server/domain/PipelineTimeline.java | 2 +- .../thoughtworks/go/server/domain/ServerBackup.java | 2 +- .../go/server/domain/xml/JobXmlViewModel.java | 2 +- .../go/server/domain/xml/PipelineXmlViewModel.java | 8 ++++---- .../go/server/domain/xml/StageXmlViewModel.java | 8 ++------ .../materials/ConfigMaterialPostUpdateQueue.java | 2 +- .../ConfigMaterialUpdateCompletedTopic.java | 2 +- .../server/materials/ConfigMaterialUpdateQueue.java | 2 +- .../materials/DependencyMaterialUpdateQueue.java | 2 +- .../go/server/materials/LegacyMaterialChecker.java | 8 ++++---- .../go/server/materials/MaterialChecker.java | 6 +++--- .../go/server/materials/MaterialDatabaseUpdater.java | 2 +- .../materials/MaterialUpdateCompletedMessage.java | 4 ++-- .../materials/MaterialUpdateCompletedTopic.java | 2 +- .../materials/MaterialUpdateFailedMessage.java | 2 +- .../go/server/materials/MaterialUpdateListener.java | 2 +- .../go/server/materials/MaterialUpdateMessage.java | 2 +- .../go/server/materials/MaterialUpdateQueue.java | 2 +- .../go/server/materials/MaterialUpdateService.java | 2 +- .../materials/MaterialUpdateSkippedMessage.java | 2 +- .../materials/MaterialUpdateSuccessfulMessage.java | 2 +- .../go/server/materials/ModificationSource.java | 12 ++++++------ .../materials/SpecificMaterialRevisionFactory.java | 6 +++--- .../postcommit/PostCommitHookMaterialType.java | 3 --- .../PostCommitHookMaterialTypeResolver.java | 8 ++++---- .../go/server/messaging/ServerBackupQueue.java | 2 +- .../thoughtworks/go/server/persistence/AgentDao.java | 2 +- .../server/persistence/ArtifactPlanRepository.java | 2 +- .../go/server/persistence/PipelineRepository.java | 2 +- .../go/server/persistence/ResourceRepository.java | 2 +- .../go/server/presentation/CanDeleteResult.java | 2 +- .../go/server/scheduling/ScheduleOptions.java | 2 +- .../go/server/scheduling/TriggerMonitor.java | 6 +++--- .../go/server/security/UserSearchService.java | 2 +- .../thoughtworks/go/server/service/AutoBuild.java | 2 +- .../go/server/service/BackupService.java | 2 +- .../go/server/service/BuildAssignmentService.java | 2 +- .../thoughtworks/go/server/service/BuildType.java | 2 +- .../server/service/ConfigRepositoryInitializer.java | 2 +- .../go/server/service/DiskSpaceChecker.java | 2 +- .../go/server/service/EnvironmentConfigService.java | 2 +- .../thoughtworks/go/server/service/FeedResolver.java | 2 +- .../go/server/service/JobResolverService.java | 2 +- .../thoughtworks/go/server/service/ManualBuild.java | 8 ++++---- .../go/server/service/MaterialConfigService.java | 2 +- .../go/server/service/MaterialService.java | 2 +- ...icationsPresentForDependentMaterialException.java | 3 --- .../go/server/service/PipelineConfigService.java | 2 +- .../go/server/service/PipelineLockChecker.java | 8 ++++---- .../go/server/service/PipelineLockService.java | 2 +- .../go/server/service/PipelineUnlockApiService.java | 2 +- .../go/server/service/ScheduledPipelineLoader.java | 2 +- .../go/server/service/StageLockChecker.java | 2 +- .../thoughtworks/go/server/service/TimedBuild.java | 2 +- .../go/server/service/TimerScheduler.java | 2 +- .../service/result/DiskSpaceOperationResult.java | 2 +- .../ServerHealthServiceUpdatingOperationResult.java | 2 +- .../support/ServerHealthInformationProvider.java | 2 +- .../server/service/support/ServerInfoProvider.java | 2 +- .../thoughtworks/go/server/ui/AgentViewModel.java | 2 +- .../thoughtworks/go/server/ui/AgentsViewModel.java | 2 +- .../thoughtworks/go/server/ui/JobInstancesModel.java | 2 +- .../go/server/ui/ModificationForPipeline.java | 2 +- .../com/thoughtworks/go/server/ui/PipelineId.java | 2 +- .../com/thoughtworks/go/server/ui/SortOrder.java | 3 --- .../go/server/ui/StageSummaryModels.java | 2 +- .../go/server/util/LastOperationTime.java | 2 +- .../go/server/view/artifacts/ArtifactsView.java | 3 --- .../server/view/artifacts/PreparingArtifactFile.java | 9 +++------ .../com/thoughtworks/go/server/web/BackupFilter.java | 2 +- .../go/server/web/FlashLoadingFilter.java | 5 +++-- .../go/server/web/FlashMessageService.java | 8 ++++---- .../materials/MaterialUpdateFailedMessageTest.java | 5 +---- .../service/AutoBuildTriangleDependencyTest.java | 3 --- .../com/thoughtworks/go/server/web/HttpTestUtil.java | 2 +- .../com/thoughtworks/go/util/GoConfigFileHelper.java | 2 +- .../java/com/thoughtworks/go/ArgPrintingMain.java | 2 +- .../thoughtworks/go/util/SerializationTester.java | 2 +- .../thoughtworks/go/util/DynamicReadWriteLock.java | 2 +- .../com/thoughtworks/go/util/VoidThrowingFn.java | 3 --- 219 files changed, 292 insertions(+), 359 deletions(-) diff --git a/agent-bootstrapper/src/main/java/com/thoughtworks/go/agent/bootstrapper/AgentLauncherCreator.java b/agent-bootstrapper/src/main/java/com/thoughtworks/go/agent/bootstrapper/AgentLauncherCreator.java index f28c1e1c214..4f454e045b3 100644 --- a/agent-bootstrapper/src/main/java/com/thoughtworks/go/agent/bootstrapper/AgentLauncherCreator.java +++ b/agent-bootstrapper/src/main/java/com/thoughtworks/go/agent/bootstrapper/AgentLauncherCreator.java @@ -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(); diff --git a/agent-common/src/main/java/com/thoughtworks/cruise/agent/common/launcher/AgentLauncher.java b/agent-common/src/main/java/com/thoughtworks/cruise/agent/common/launcher/AgentLauncher.java index 00a771edf75..4a60e40d117 100644 --- a/agent-common/src/main/java/com/thoughtworks/cruise/agent/common/launcher/AgentLauncher.java +++ b/agent-common/src/main/java/com/thoughtworks/cruise/agent/common/launcher/AgentLauncher.java @@ -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 { diff --git a/common/src/main/java/com/thoughtworks/go/domain/AgentInstance.java b/common/src/main/java/com/thoughtworks/go/domain/AgentInstance.java index 38a1342214b..ef52deec118 100644 --- a/common/src/main/java/com/thoughtworks/go/domain/AgentInstance.java +++ b/common/src/main/java/com/thoughtworks/go/domain/AgentInstance.java @@ -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 { private final AgentType agentType; diff --git a/common/src/main/java/com/thoughtworks/go/domain/AgentRuntimeStatus.java b/common/src/main/java/com/thoughtworks/go/domain/AgentRuntimeStatus.java index 5791d4f5114..2dae89456a6 100644 --- a/common/src/main/java/com/thoughtworks/go/domain/AgentRuntimeStatus.java +++ b/common/src/main/java/com/thoughtworks/go/domain/AgentRuntimeStatus.java @@ -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; diff --git a/common/src/main/java/com/thoughtworks/go/domain/AgentStatus.java b/common/src/main/java/com/thoughtworks/go/domain/AgentStatus.java index eccb6538bfd..258cb7abf91 100644 --- a/common/src/main/java/com/thoughtworks/go/domain/AgentStatus.java +++ b/common/src/main/java/com/thoughtworks/go/domain/AgentStatus.java @@ -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, Serializable { Pending("Pending", AgentConfigStatus.Pending, AgentRuntimeStatus.Unknown), diff --git a/common/src/main/java/com/thoughtworks/go/domain/ArtifactUrlReader.java b/common/src/main/java/com/thoughtworks/go/domain/ArtifactUrlReader.java index e05658ae86c..34c6d7e8b58 100644 --- a/common/src/main/java/com/thoughtworks/go/domain/ArtifactUrlReader.java +++ b/common/src/main/java/com/thoughtworks/go/domain/ArtifactUrlReader.java @@ -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; diff --git a/common/src/main/java/com/thoughtworks/go/domain/DiskSpace.java b/common/src/main/java/com/thoughtworks/go/domain/DiskSpace.java index 8d19b9ce818..d0aea3d6a18 100644 --- a/common/src/main/java/com/thoughtworks/go/domain/DiskSpace.java +++ b/common/src/main/java/com/thoughtworks/go/domain/DiskSpace.java @@ -18,7 +18,7 @@ import com.thoughtworks.go.util.FileSizeUtils; /** - * @understands storage measurement + * Understands storage measurement */ public class DiskSpace implements Comparable { private final Long space; diff --git a/common/src/main/java/com/thoughtworks/go/domain/JobPlanLoader.java b/common/src/main/java/com/thoughtworks/go/domain/JobPlanLoader.java index a80e0da0da0..ad72c524619 100644 --- a/common/src/main/java/com/thoughtworks/go/domain/JobPlanLoader.java +++ b/common/src/main/java/com/thoughtworks/go/domain/JobPlanLoader.java @@ -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); diff --git a/common/src/main/java/com/thoughtworks/go/domain/PipelineMaterialRevision.java b/common/src/main/java/com/thoughtworks/go/domain/PipelineMaterialRevision.java index 3e7c1bb2d85..00cdff9340a 100644 --- a/common/src/main/java/com/thoughtworks/go/domain/PipelineMaterialRevision.java +++ b/common/src/main/java/com/thoughtworks/go/domain/PipelineMaterialRevision.java @@ -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; diff --git a/common/src/main/java/com/thoughtworks/go/domain/PipelineTimelineEntry.java b/common/src/main/java/com/thoughtworks/go/domain/PipelineTimelineEntry.java index 80146be3623..84c6943f47e 100644 --- a/common/src/main/java/com/thoughtworks/go/domain/PipelineTimelineEntry.java +++ b/common/src/main/java/com/thoughtworks/go/domain/PipelineTimelineEntry.java @@ -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; diff --git a/common/src/main/java/com/thoughtworks/go/domain/XmlRepresentable.java b/common/src/main/java/com/thoughtworks/go/domain/XmlRepresentable.java index 107a6d01d9a..5f7c6b30ea5 100644 --- a/common/src/main/java/com/thoughtworks/go/domain/XmlRepresentable.java +++ b/common/src/main/java/com/thoughtworks/go/domain/XmlRepresentable.java @@ -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); diff --git a/common/src/main/java/com/thoughtworks/go/domain/XmlWriterContext.java b/common/src/main/java/com/thoughtworks/go/domain/XmlWriterContext.java index d621dcbe76d..5b73b10817c 100644 --- a/common/src/main/java/com/thoughtworks/go/domain/XmlWriterContext.java +++ b/common/src/main/java/com/thoughtworks/go/domain/XmlWriterContext.java @@ -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; diff --git a/common/src/main/java/com/thoughtworks/go/i18n/LocalizedMessage.java b/common/src/main/java/com/thoughtworks/go/i18n/LocalizedMessage.java index 8c8e994264d..1fc8388ec50 100644 --- a/common/src/main/java/com/thoughtworks/go/i18n/LocalizedMessage.java +++ b/common/src/main/java/com/thoughtworks/go/i18n/LocalizedMessage.java @@ -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 { diff --git a/common/src/main/java/com/thoughtworks/go/presentation/TriStateSelection.java b/common/src/main/java/com/thoughtworks/go/presentation/TriStateSelection.java index 29f1bf720bb..adbc9dd3dc5 100644 --- a/common/src/main/java/com/thoughtworks/go/presentation/TriStateSelection.java +++ b/common/src/main/java/com/thoughtworks/go/presentation/TriStateSelection.java @@ -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 { private String value; diff --git a/common/src/main/java/com/thoughtworks/go/presentation/pipelinehistory/EmptyPipelineInstanceModel.java b/common/src/main/java/com/thoughtworks/go/presentation/pipelinehistory/EmptyPipelineInstanceModel.java index 36aecdf7e25..ed26e484d04 100644 --- a/common/src/main/java/com/thoughtworks/go/presentation/pipelinehistory/EmptyPipelineInstanceModel.java +++ b/common/src/main/java/com/thoughtworks/go/presentation/pipelinehistory/EmptyPipelineInstanceModel.java @@ -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) { diff --git a/common/src/main/java/com/thoughtworks/go/presentation/pipelinehistory/Environment.java b/common/src/main/java/com/thoughtworks/go/presentation/pipelinehistory/Environment.java index 562d7f0c66c..839dcec67d3 100644 --- a/common/src/main/java/com/thoughtworks/go/presentation/pipelinehistory/Environment.java +++ b/common/src/main/java/com/thoughtworks/go/presentation/pipelinehistory/Environment.java @@ -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; diff --git a/common/src/main/java/com/thoughtworks/go/presentation/pipelinehistory/PipelineGroupModel.java b/common/src/main/java/com/thoughtworks/go/presentation/pipelinehistory/PipelineGroupModel.java index de0925461f4..1cc7e275f50 100644 --- a/common/src/main/java/com/thoughtworks/go/presentation/pipelinehistory/PipelineGroupModel.java +++ b/common/src/main/java/com/thoughtworks/go/presentation/pipelinehistory/PipelineGroupModel.java @@ -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; diff --git a/common/src/main/java/com/thoughtworks/go/presentation/pipelinehistory/PipelineInstanceModel.java b/common/src/main/java/com/thoughtworks/go/presentation/pipelinehistory/PipelineInstanceModel.java index e5c0fe081b6..dc895675e6d 100644 --- a/common/src/main/java/com/thoughtworks/go/presentation/pipelinehistory/PipelineInstanceModel.java +++ b/common/src/main/java/com/thoughtworks/go/presentation/pipelinehistory/PipelineInstanceModel.java @@ -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() { diff --git a/common/src/main/java/com/thoughtworks/go/presentation/pipelinehistory/PreparingToScheduleInstance.java b/common/src/main/java/com/thoughtworks/go/presentation/pipelinehistory/PreparingToScheduleInstance.java index 4fc61963372..63a1feeb7f0 100644 --- a/common/src/main/java/com/thoughtworks/go/presentation/pipelinehistory/PreparingToScheduleInstance.java +++ b/common/src/main/java/com/thoughtworks/go/presentation/pipelinehistory/PreparingToScheduleInstance.java @@ -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 { diff --git a/common/src/main/java/com/thoughtworks/go/presentation/pipelinehistory/StageHistoryEntry.java b/common/src/main/java/com/thoughtworks/go/presentation/pipelinehistory/StageHistoryEntry.java index 2ae40bed0ec..97283b7657b 100644 --- a/common/src/main/java/com/thoughtworks/go/presentation/pipelinehistory/StageHistoryEntry.java +++ b/common/src/main/java/com/thoughtworks/go/presentation/pipelinehistory/StageHistoryEntry.java @@ -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; diff --git a/common/src/main/java/com/thoughtworks/go/presentation/pipelinehistory/StageHistoryPage.java b/common/src/main/java/com/thoughtworks/go/presentation/pipelinehistory/StageHistoryPage.java index 6161bfabde1..75d7fdd56ca 100644 --- a/common/src/main/java/com/thoughtworks/go/presentation/pipelinehistory/StageHistoryPage.java +++ b/common/src/main/java/com/thoughtworks/go/presentation/pipelinehistory/StageHistoryPage.java @@ -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 stages; diff --git a/common/src/main/java/com/thoughtworks/go/server/service/AgentNoCookieSetException.java b/common/src/main/java/com/thoughtworks/go/server/service/AgentNoCookieSetException.java index cbff4b9b00b..d6355a7d8ca 100644 --- a/common/src/main/java/com/thoughtworks/go/server/service/AgentNoCookieSetException.java +++ b/common/src/main/java/com/thoughtworks/go/server/service/AgentNoCookieSetException.java @@ -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) { diff --git a/common/src/main/java/com/thoughtworks/go/server/service/AgentWithDuplicateUUIDException.java b/common/src/main/java/com/thoughtworks/go/server/service/AgentWithDuplicateUUIDException.java index bb6707f47d9..5699f24614e 100644 --- a/common/src/main/java/com/thoughtworks/go/server/service/AgentWithDuplicateUUIDException.java +++ b/common/src/main/java/com/thoughtworks/go/server/service/AgentWithDuplicateUUIDException.java @@ -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 { diff --git a/common/src/main/java/com/thoughtworks/go/server/service/UpstreamPipelineResolver.java b/common/src/main/java/com/thoughtworks/go/server/service/UpstreamPipelineResolver.java index 5c8e8dd25c9..d345a6e2065 100644 --- a/common/src/main/java/com/thoughtworks/go/server/service/UpstreamPipelineResolver.java +++ b/common/src/main/java/com/thoughtworks/go/server/service/UpstreamPipelineResolver.java @@ -17,9 +17,6 @@ import com.thoughtworks.go.domain.buildcause.BuildCause; -/** - * @understands: UpstreamPipelineResolver - */ public interface UpstreamPipelineResolver { BuildCause buildCauseFor(String pipelineName, int pipelineCounter); } diff --git a/common/src/main/java/com/thoughtworks/go/server/service/result/HttpLocalizedOperationResult.java b/common/src/main/java/com/thoughtworks/go/server/service/result/HttpLocalizedOperationResult.java index fe57480721d..6b2259981cd 100644 --- a/common/src/main/java/com/thoughtworks/go/server/service/result/HttpLocalizedOperationResult.java +++ b/common/src/main/java/com/thoughtworks/go/server/service/result/HttpLocalizedOperationResult.java @@ -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; diff --git a/common/src/main/java/com/thoughtworks/go/server/service/result/HttpOperationResult.java b/common/src/main/java/com/thoughtworks/go/server/service/result/HttpOperationResult.java index bd59209d159..021d52a6d72 100644 --- a/common/src/main/java/com/thoughtworks/go/server/service/result/HttpOperationResult.java +++ b/common/src/main/java/com/thoughtworks/go/server/service/result/HttpOperationResult.java @@ -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 { diff --git a/common/src/main/java/com/thoughtworks/go/server/service/result/LocalizedOperationResult.java b/common/src/main/java/com/thoughtworks/go/server/service/result/LocalizedOperationResult.java index e693a0e7162..b2f36858212 100644 --- a/common/src/main/java/com/thoughtworks/go/server/service/result/LocalizedOperationResult.java +++ b/common/src/main/java/com/thoughtworks/go/server/service/result/LocalizedOperationResult.java @@ -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 { diff --git a/common/src/main/java/com/thoughtworks/go/server/service/result/OperationResult.java b/common/src/main/java/com/thoughtworks/go/server/service/result/OperationResult.java index 8e366568405..b2c718d8d1d 100644 --- a/common/src/main/java/com/thoughtworks/go/server/service/result/OperationResult.java +++ b/common/src/main/java/com/thoughtworks/go/server/service/result/OperationResult.java @@ -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 { diff --git a/common/src/main/java/com/thoughtworks/go/server/service/result/ServerHealthStateOperationResult.java b/common/src/main/java/com/thoughtworks/go/server/service/result/ServerHealthStateOperationResult.java index 591bcb192db..ab9f7d21fcd 100644 --- a/common/src/main/java/com/thoughtworks/go/server/service/result/ServerHealthStateOperationResult.java +++ b/common/src/main/java/com/thoughtworks/go/server/service/result/ServerHealthStateOperationResult.java @@ -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; diff --git a/common/src/main/java/com/thoughtworks/go/server/util/UuidGenerator.java b/common/src/main/java/com/thoughtworks/go/server/util/UuidGenerator.java index 5c777c3f569..ffa94d54291 100644 --- a/common/src/main/java/com/thoughtworks/go/server/util/UuidGenerator.java +++ b/common/src/main/java/com/thoughtworks/go/server/util/UuidGenerator.java @@ -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 { diff --git a/common/src/main/java/com/thoughtworks/go/serverhealth/ServerHealthStates.java b/common/src/main/java/com/thoughtworks/go/serverhealth/ServerHealthStates.java index 65a33514f7f..7f1c99bd3c2 100644 --- a/common/src/main/java/com/thoughtworks/go/serverhealth/ServerHealthStates.java +++ b/common/src/main/java/com/thoughtworks/go/serverhealth/ServerHealthStates.java @@ -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 { public ServerHealthStates(List serverHealthStates) { diff --git a/common/src/main/java/com/thoughtworks/go/util/SubprocessLogger.java b/common/src/main/java/com/thoughtworks/go/util/SubprocessLogger.java index 1473eefe765..00b09bcf989 100644 --- a/common/src/main/java/com/thoughtworks/go/util/SubprocessLogger.java +++ b/common/src/main/java/com/thoughtworks/go/util/SubprocessLogger.java @@ -20,7 +20,7 @@ import org.slf4j.LoggerFactory; /** - * @understands handling subprocesses + * Understands handling subprocesses */ public class SubprocessLogger implements Runnable { private CurrentProcess currentProcess; diff --git a/common/src/test/java/com/thoughtworks/go/domain/DirectoryEntriesTest.java b/common/src/test/java/com/thoughtworks/go/domain/DirectoryEntriesTest.java index 64aa3d0b8c0..16c5c9369da 100644 --- a/common/src/test/java/com/thoughtworks/go/domain/DirectoryEntriesTest.java +++ b/common/src/test/java/com/thoughtworks/go/domain/DirectoryEntriesTest.java @@ -29,9 +29,6 @@ import static org.hamcrest.Matchers.hasItem; import static org.hamcrest.Matchers.is; -/** - * @understands - */ public class DirectoryEntriesTest { @Test diff --git a/config/config-api/src/main/java/com/thoughtworks/go/config/BasicCruiseConfig.java b/config/config-api/src/main/java/com/thoughtworks/go/config/BasicCruiseConfig.java index b57fded6ba3..79394b704fd 100644 --- a/config/config-api/src/main/java/com/thoughtworks/go/config/BasicCruiseConfig.java +++ b/config/config-api/src/main/java/com/thoughtworks/go/config/BasicCruiseConfig.java @@ -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 { diff --git a/config/config-api/src/main/java/com/thoughtworks/go/config/BasicEnvironmentConfig.java b/config/config-api/src/main/java/com/thoughtworks/go/config/BasicEnvironmentConfig.java index 785ed890701..0eaf2a2139a 100644 --- a/config/config-api/src/main/java/com/thoughtworks/go/config/BasicEnvironmentConfig.java +++ b/config/config-api/src/main/java/com/thoughtworks/go/config/BasicEnvironmentConfig.java @@ -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 { diff --git a/config/config-api/src/main/java/com/thoughtworks/go/config/ConfigAttributeValue.java b/config/config-api/src/main/java/com/thoughtworks/go/config/ConfigAttributeValue.java index 5f419365190..4e7f366f8ba 100644 --- a/config/config-api/src/main/java/com/thoughtworks/go/config/ConfigAttributeValue.java +++ b/config/config-api/src/main/java/com/thoughtworks/go/config/ConfigAttributeValue.java @@ -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) diff --git a/config/config-api/src/main/java/com/thoughtworks/go/config/ConfigElementInstantiator.java b/config/config-api/src/main/java/com/thoughtworks/go/config/ConfigElementInstantiator.java index 58cc614ade7..371c200de46 100644 --- a/config/config-api/src/main/java/com/thoughtworks/go/config/ConfigElementInstantiator.java +++ b/config/config-api/src/main/java/com/thoughtworks/go/config/ConfigElementInstantiator.java @@ -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 instantiateConfigElement(GoCipher goCipher, Class toGenerate) { diff --git a/config/config-api/src/main/java/com/thoughtworks/go/config/ConfigSaveValidationContext.java b/config/config-api/src/main/java/com/thoughtworks/go/config/ConfigSaveValidationContext.java index adffa85f83f..081b5ea7f17 100644 --- a/config/config-api/src/main/java/com/thoughtworks/go/config/ConfigSaveValidationContext.java +++ b/config/config-api/src/main/java/com/thoughtworks/go/config/ConfigSaveValidationContext.java @@ -30,7 +30,7 @@ import java.util.Map; /** - * @understands providing right state required to validate a given config element + * Understands providing right state required to validate a given config element */ public class ConfigSaveValidationContext implements ValidationContext { private final Validatable immediateParent; diff --git a/config/config-api/src/main/java/com/thoughtworks/go/config/CruiseConfig.java b/config/config-api/src/main/java/com/thoughtworks/go/config/CruiseConfig.java index 96e16109910..ef652424ffd 100644 --- a/config/config-api/src/main/java/com/thoughtworks/go/config/CruiseConfig.java +++ b/config/config-api/src/main/java/com/thoughtworks/go/config/CruiseConfig.java @@ -29,10 +29,13 @@ import com.thoughtworks.go.util.Node; import javax.annotation.PostConstruct; -import java.util.*; +import java.util.Hashtable; +import java.util.List; +import java.util.Map; +import java.util.Set; /** - * @understands the configuration for cruise + * Understands the configuration for cruise */ public interface CruiseConfig extends Validatable, ConfigOriginTraceable { String WORKING_BASE_DIR = "pipelines/"; diff --git a/config/config-api/src/main/java/com/thoughtworks/go/config/EncryptedVariableValueConfig.java b/config/config-api/src/main/java/com/thoughtworks/go/config/EncryptedVariableValueConfig.java index a0e3eb6bf2d..8ec2fbf8120 100644 --- a/config/config-api/src/main/java/com/thoughtworks/go/config/EncryptedVariableValueConfig.java +++ b/config/config-api/src/main/java/com/thoughtworks/go/config/EncryptedVariableValueConfig.java @@ -18,7 +18,7 @@ import java.io.Serializable; /** - * @understands encrypted values for env variables + * Understands encrypted values for env variables */ @ConfigTag("encryptedValue") public class EncryptedVariableValueConfig implements Serializable{ diff --git a/config/config-api/src/main/java/com/thoughtworks/go/config/EnvironmentAgentConfig.java b/config/config-api/src/main/java/com/thoughtworks/go/config/EnvironmentAgentConfig.java index c279fb4559a..8e65876f2ff 100644 --- a/config/config-api/src/main/java/com/thoughtworks/go/config/EnvironmentAgentConfig.java +++ b/config/config-api/src/main/java/com/thoughtworks/go/config/EnvironmentAgentConfig.java @@ -23,7 +23,7 @@ import static org.apache.commons.collections4.CollectionUtils.isEmpty; /** - * @understands a reference to an existing agent that is associated to an Environment + * Understands a reference to an existing agent that is associated to an Environment */ public class EnvironmentAgentConfig implements Validatable { private String uuid; diff --git a/config/config-api/src/main/java/com/thoughtworks/go/config/EnvironmentAgentsConfig.java b/config/config-api/src/main/java/com/thoughtworks/go/config/EnvironmentAgentsConfig.java index ea67de75681..c3868070cb0 100644 --- a/config/config-api/src/main/java/com/thoughtworks/go/config/EnvironmentAgentsConfig.java +++ b/config/config-api/src/main/java/com/thoughtworks/go/config/EnvironmentAgentsConfig.java @@ -24,7 +24,7 @@ import static java.util.stream.Collectors.toList; /** -* @understands references to existing agents that are associated to an Environment +* Understands references to existing agents that are associated to an Environment */ public class EnvironmentAgentsConfig extends BaseCollection implements ParamsAttributeAware, Validatable { private final ConfigErrors configErrors = new ConfigErrors(); diff --git a/config/config-api/src/main/java/com/thoughtworks/go/config/EnvironmentConfig.java b/config/config-api/src/main/java/com/thoughtworks/go/config/EnvironmentConfig.java index bd9f84a228e..75ef2bf121a 100644 --- a/config/config-api/src/main/java/com/thoughtworks/go/config/EnvironmentConfig.java +++ b/config/config-api/src/main/java/com/thoughtworks/go/config/EnvironmentConfig.java @@ -26,7 +26,7 @@ import java.util.Set; /** - * @understands the current persistent information related to a logical grouping of machines + * Understands the current persistent information related to a logical grouping of machines */ public interface EnvironmentConfig extends ParamsAttributeAware, Validatable, EnvironmentVariableScope, ConfigOriginTraceable, SecretParamAware { diff --git a/config/config-api/src/main/java/com/thoughtworks/go/config/EnvironmentPipelineConfig.java b/config/config-api/src/main/java/com/thoughtworks/go/config/EnvironmentPipelineConfig.java index 4b1d9ddde6e..d54ffca75e2 100644 --- a/config/config-api/src/main/java/com/thoughtworks/go/config/EnvironmentPipelineConfig.java +++ b/config/config-api/src/main/java/com/thoughtworks/go/config/EnvironmentPipelineConfig.java @@ -15,12 +15,12 @@ */ package com.thoughtworks.go.config; -import java.util.List; - import com.thoughtworks.go.domain.ConfigErrors; +import java.util.List; + /** - * @understands a reference to an existing pipeline that is associated to an Environment + * Understands a reference to an existing pipeline that is associated to an Environment */ @ConfigTag("pipeline") public class EnvironmentPipelineConfig implements Validatable { diff --git a/config/config-api/src/main/java/com/thoughtworks/go/config/EnvironmentPipelinesConfig.java b/config/config-api/src/main/java/com/thoughtworks/go/config/EnvironmentPipelinesConfig.java index 55b08aefbe2..91b7eed2787 100644 --- a/config/config-api/src/main/java/com/thoughtworks/go/config/EnvironmentPipelinesConfig.java +++ b/config/config-api/src/main/java/com/thoughtworks/go/config/EnvironmentPipelinesConfig.java @@ -24,7 +24,7 @@ import java.util.Map; /** - * @understands references to existing pipelines that are associated to an Environment + * Understands references to existing pipelines that are associated to an Environment */ @ConfigTag("pipelines") @ConfigCollection(EnvironmentPipelineConfig.class) diff --git a/config/config-api/src/main/java/com/thoughtworks/go/config/EnvironmentVariableConfig.java b/config/config-api/src/main/java/com/thoughtworks/go/config/EnvironmentVariableConfig.java index fa226bf7a91..04c4e75b071 100644 --- a/config/config-api/src/main/java/com/thoughtworks/go/config/EnvironmentVariableConfig.java +++ b/config/config-api/src/main/java/com/thoughtworks/go/config/EnvironmentVariableConfig.java @@ -33,7 +33,7 @@ import static java.lang.String.format; /** - * @understands an environment variable value that will be passed to a job when it is run + * Understands an environment variable value that will be passed to a job when it is run */ @ConfigTag("variable") public class EnvironmentVariableConfig implements Serializable, Validatable, ParamsAttributeAware, PasswordEncrypter, ConfigOriginTraceable, SecretParamAware { diff --git a/config/config-api/src/main/java/com/thoughtworks/go/config/EnvironmentVariablesConfig.java b/config/config-api/src/main/java/com/thoughtworks/go/config/EnvironmentVariablesConfig.java index a401a327385..f7e3ad01de6 100644 --- a/config/config-api/src/main/java/com/thoughtworks/go/config/EnvironmentVariablesConfig.java +++ b/config/config-api/src/main/java/com/thoughtworks/go/config/EnvironmentVariablesConfig.java @@ -26,7 +26,7 @@ import java.util.Map; /** - * @understands environment variables that are passed to a running job + * Understands environment variables that are passed to a running job */ @ConfigTag("environmentvariables") @ConfigCollection(EnvironmentVariableConfig.class) diff --git a/config/config-api/src/main/java/com/thoughtworks/go/config/EnvironmentsConfig.java b/config/config-api/src/main/java/com/thoughtworks/go/config/EnvironmentsConfig.java index 05e5b38b785..21a13002721 100644 --- a/config/config-api/src/main/java/com/thoughtworks/go/config/EnvironmentsConfig.java +++ b/config/config-api/src/main/java/com/thoughtworks/go/config/EnvironmentsConfig.java @@ -28,7 +28,7 @@ import static java.util.stream.Collectors.*; /** - * @understands the current persistent information related to multiple logical groupings of machines + * Understands the current persistent information related to multiple logical groupings of machines */ @ConfigTag("environments") @ConfigCollection(BasicEnvironmentConfig.class) diff --git a/config/config-api/src/main/java/com/thoughtworks/go/config/GoConfigGraphWalker.java b/config/config-api/src/main/java/com/thoughtworks/go/config/GoConfigGraphWalker.java index 10a59b36cd7..1a60da466f1 100644 --- a/config/config-api/src/main/java/com/thoughtworks/go/config/GoConfigGraphWalker.java +++ b/config/config-api/src/main/java/com/thoughtworks/go/config/GoConfigGraphWalker.java @@ -15,6 +15,8 @@ */ package com.thoughtworks.go.config; +import com.thoughtworks.go.config.preprocessor.ClassAttributeCache; + import java.lang.reflect.Field; import java.lang.reflect.Modifier; import java.util.AbstractMap; @@ -22,10 +24,8 @@ import java.util.Collection; import java.util.List; -import com.thoughtworks.go.config.preprocessor.ClassAttributeCache; - /** - * @understands visits all the nodes in the cruise config once using Java reflection + * Understands visits all the nodes in the cruise config once using Java reflection */ public class GoConfigGraphWalker { private final Validatable rootValidatable; diff --git a/config/config-api/src/main/java/com/thoughtworks/go/config/GoConfigPreprocessor.java b/config/config-api/src/main/java/com/thoughtworks/go/config/GoConfigPreprocessor.java index ce23def0724..12651e63b15 100644 --- a/config/config-api/src/main/java/com/thoughtworks/go/config/GoConfigPreprocessor.java +++ b/config/config-api/src/main/java/com/thoughtworks/go/config/GoConfigPreprocessor.java @@ -16,7 +16,7 @@ package com.thoughtworks.go.config; /** - * @understands unidirectonal transformation of persistable config object to usable config object + * Understands unidirectonal transformation of persistable config object to usable config object */ public interface GoConfigPreprocessor { void process(CruiseConfig cruiseConfig); diff --git a/config/config-api/src/main/java/com/thoughtworks/go/config/JobConfig.java b/config/config-api/src/main/java/com/thoughtworks/go/config/JobConfig.java index 764c9a263e0..2a5373b4e54 100644 --- a/config/config-api/src/main/java/com/thoughtworks/go/config/JobConfig.java +++ b/config/config-api/src/main/java/com/thoughtworks/go/config/JobConfig.java @@ -33,7 +33,7 @@ import static org.apache.commons.lang3.StringUtils.isBlank; /** - * @understands configuratin for a job + * Understands configuratin for a job */ @ConfigTag("job") public class JobConfig implements Validatable, ParamsAttributeAware, EnvironmentVariableScope { diff --git a/config/config-api/src/main/java/com/thoughtworks/go/config/MqlCriteria.java b/config/config-api/src/main/java/com/thoughtworks/go/config/MqlCriteria.java index 79709428e1f..e7e17ae6089 100644 --- a/config/config-api/src/main/java/com/thoughtworks/go/config/MqlCriteria.java +++ b/config/config-api/src/main/java/com/thoughtworks/go/config/MqlCriteria.java @@ -15,14 +15,14 @@ */ package com.thoughtworks.go.config; -import java.util.Map; - import com.thoughtworks.go.domain.ConfigErrors; import org.apache.commons.lang3.StringUtils; import org.apache.commons.lang3.builder.ToStringBuilder; +import java.util.Map; + /** - * @understands MQL criteria for a mingle config + * Understands MQL criteria for a mingle config */ @ConfigTag("mqlGroupingConditions") public class MqlCriteria implements ParamsAttributeAware, Validatable { diff --git a/config/config-api/src/main/java/com/thoughtworks/go/config/ParamsAttributeAware.java b/config/config-api/src/main/java/com/thoughtworks/go/config/ParamsAttributeAware.java index 4aaa8ecef2f..c1fbb2c723b 100644 --- a/config/config-api/src/main/java/com/thoughtworks/go/config/ParamsAttributeAware.java +++ b/config/config-api/src/main/java/com/thoughtworks/go/config/ParamsAttributeAware.java @@ -15,9 +15,6 @@ */ package com.thoughtworks.go.config; -/** - * @understands - */ public interface ParamsAttributeAware { void setConfigAttributes(Object attributes); } diff --git a/config/config-api/src/main/java/com/thoughtworks/go/config/PipelineConfig.java b/config/config-api/src/main/java/com/thoughtworks/go/config/PipelineConfig.java index 3395566e074..770a2985891 100644 --- a/config/config-api/src/main/java/com/thoughtworks/go/config/PipelineConfig.java +++ b/config/config-api/src/main/java/com/thoughtworks/go/config/PipelineConfig.java @@ -54,7 +54,7 @@ import static org.apache.commons.lang3.StringUtils.substringsBetween; /** - * @understands how a cruise pipeline is configured by the user + * Understands how a cruise pipeline is configured by the user */ @ConfigTag("pipeline") @ConfigCollection(StageConfig.class) diff --git a/config/config-api/src/main/java/com/thoughtworks/go/config/PipelineTemplateConfig.java b/config/config-api/src/main/java/com/thoughtworks/go/config/PipelineTemplateConfig.java index cec1e9685a2..e83b5065f31 100644 --- a/config/config-api/src/main/java/com/thoughtworks/go/config/PipelineTemplateConfig.java +++ b/config/config-api/src/main/java/com/thoughtworks/go/config/PipelineTemplateConfig.java @@ -33,9 +33,8 @@ import static com.thoughtworks.go.config.Authorization.ALLOW_GROUP_ADMINS; /** - * @understands abstracting a pipeline definition + * Understands abstracting a pipeline definition */ - @ConfigTag("pipeline") @ConfigCollection(value = StageConfig.class) public class PipelineTemplateConfig extends BaseCollection implements Validatable, ParamsAttributeAware { diff --git a/config/config-api/src/main/java/com/thoughtworks/go/config/StageConfig.java b/config/config-api/src/main/java/com/thoughtworks/go/config/StageConfig.java index 08b36fee7a3..869fbadc988 100644 --- a/config/config-api/src/main/java/com/thoughtworks/go/config/StageConfig.java +++ b/config/config-api/src/main/java/com/thoughtworks/go/config/StageConfig.java @@ -25,7 +25,7 @@ import java.util.Map; /** - * @understands the configuration for a stage + * Understands the configuration for a stage */ @ConfigTag("stage") public class StageConfig implements Validatable, ParamsAttributeAware, EnvironmentVariableScope { diff --git a/config/config-api/src/main/java/com/thoughtworks/go/config/TemplateExpansionPreprocessor.java b/config/config-api/src/main/java/com/thoughtworks/go/config/TemplateExpansionPreprocessor.java index 8ee9bf0ddbc..f4650d9d953 100644 --- a/config/config-api/src/main/java/com/thoughtworks/go/config/TemplateExpansionPreprocessor.java +++ b/config/config-api/src/main/java/com/thoughtworks/go/config/TemplateExpansionPreprocessor.java @@ -16,7 +16,7 @@ package com.thoughtworks.go.config; /** - * @understands de-referencing template body into pipeline + * Understands de-referencing template body into pipeline */ public class TemplateExpansionPreprocessor implements GoConfigPreprocessor { @Override diff --git a/config/config-api/src/main/java/com/thoughtworks/go/config/TemplateToPipelines.java b/config/config-api/src/main/java/com/thoughtworks/go/config/TemplateToPipelines.java index a2cb8534432..40d2e058b42 100644 --- a/config/config-api/src/main/java/com/thoughtworks/go/config/TemplateToPipelines.java +++ b/config/config-api/src/main/java/com/thoughtworks/go/config/TemplateToPipelines.java @@ -15,12 +15,12 @@ */ package com.thoughtworks.go.config; -import java.util.*; +import java.util.ArrayList; +import java.util.List; /** - * @understands a custom data structure for templates to editable pipelines. + * Understands a custom data structure for templates to editable pipelines. */ - public class TemplateToPipelines { private List pipelines = new ArrayList<>(); private CaseInsensitiveString templateName; diff --git a/config/config-api/src/main/java/com/thoughtworks/go/config/TemplatesConfig.java b/config/config-api/src/main/java/com/thoughtworks/go/config/TemplatesConfig.java index 1af6d69dd9c..92958da4425 100644 --- a/config/config-api/src/main/java/com/thoughtworks/go/config/TemplatesConfig.java +++ b/config/config-api/src/main/java/com/thoughtworks/go/config/TemplatesConfig.java @@ -24,7 +24,7 @@ import java.util.Map; /** - * @understands a collection of configuration abstractions + * Understands a collection of configuration abstractions */ @ConfigTag("templates") @ConfigCollection(PipelineTemplateConfig.class) diff --git a/config/config-api/src/main/java/com/thoughtworks/go/config/TimerConfig.java b/config/config-api/src/main/java/com/thoughtworks/go/config/TimerConfig.java index ad03a5d90a2..8bf3f584a2c 100644 --- a/config/config-api/src/main/java/com/thoughtworks/go/config/TimerConfig.java +++ b/config/config-api/src/main/java/com/thoughtworks/go/config/TimerConfig.java @@ -23,7 +23,7 @@ /** - * @understands Configuration of a Pipeline cron timer + * Understands Configuration of a Pipeline cron timer */ @ConfigTag("timer") public class TimerConfig implements Validatable { diff --git a/config/config-api/src/main/java/com/thoughtworks/go/config/ValidationErrorKey.java b/config/config-api/src/main/java/com/thoughtworks/go/config/ValidationErrorKey.java index bd6a6d99bbf..2461beb17a1 100644 --- a/config/config-api/src/main/java/com/thoughtworks/go/config/ValidationErrorKey.java +++ b/config/config-api/src/main/java/com/thoughtworks/go/config/ValidationErrorKey.java @@ -23,7 +23,7 @@ /** - * @understands key for error validation (used by views) + * Understands key for error validation (used by views) */ @Retention(RUNTIME) @Target(FIELD) diff --git a/config/config-api/src/main/java/com/thoughtworks/go/config/VariableValueConfig.java b/config/config-api/src/main/java/com/thoughtworks/go/config/VariableValueConfig.java index 61701c9ce7f..e41e436c0ec 100644 --- a/config/config-api/src/main/java/com/thoughtworks/go/config/VariableValueConfig.java +++ b/config/config-api/src/main/java/com/thoughtworks/go/config/VariableValueConfig.java @@ -18,7 +18,7 @@ import java.io.Serializable; /** - * @understands Value of env variable + * Understands Value of env variable */ @ConfigTag("value") public class VariableValueConfig implements Serializable { diff --git a/config/config-api/src/main/java/com/thoughtworks/go/config/materials/AbstractMaterialConfig.java b/config/config-api/src/main/java/com/thoughtworks/go/config/materials/AbstractMaterialConfig.java index 294ef46394f..87cd735023e 100644 --- a/config/config-api/src/main/java/com/thoughtworks/go/config/materials/AbstractMaterialConfig.java +++ b/config/config-api/src/main/java/com/thoughtworks/go/config/materials/AbstractMaterialConfig.java @@ -26,7 +26,7 @@ import java.util.*; /** - * @understands material configuration + * Understands material configuration */ public abstract class AbstractMaterialConfig implements MaterialConfig, ParamsAttributeAware { public static final String MATERIAL_NAME = "materialName"; diff --git a/config/config-api/src/main/java/com/thoughtworks/go/config/materials/ScmMaterialConfig.java b/config/config-api/src/main/java/com/thoughtworks/go/config/materials/ScmMaterialConfig.java index e2b0167326c..0deb46308f1 100644 --- a/config/config-api/src/main/java/com/thoughtworks/go/config/materials/ScmMaterialConfig.java +++ b/config/config-api/src/main/java/com/thoughtworks/go/config/materials/ScmMaterialConfig.java @@ -32,7 +32,7 @@ import static org.apache.commons.lang3.StringUtils.*; /** - * @understands a source control repository and its configuration + * Understands a source control repository and its configuration */ public abstract class ScmMaterialConfig extends AbstractMaterialConfig implements ParamsAttributeAware { public static final String URL = "url"; diff --git a/config/config-api/src/main/java/com/thoughtworks/go/config/merge/MergeConfigOrigin.java b/config/config-api/src/main/java/com/thoughtworks/go/config/merge/MergeConfigOrigin.java index a9a40c39a45..e6c436897df 100644 --- a/config/config-api/src/main/java/com/thoughtworks/go/config/merge/MergeConfigOrigin.java +++ b/config/config-api/src/main/java/com/thoughtworks/go/config/merge/MergeConfigOrigin.java @@ -19,7 +19,7 @@ import com.thoughtworks.go.domain.BaseCollection; /** - * @understands configuration has multiple origins + * Understands configuration has multiple origins */ public class MergeConfigOrigin extends BaseCollection implements ConfigOrigin { diff --git a/config/config-api/src/main/java/com/thoughtworks/go/config/merge/MergePipelineConfigs.java b/config/config-api/src/main/java/com/thoughtworks/go/config/merge/MergePipelineConfigs.java index c2be6f99895..0dab51ae252 100644 --- a/config/config-api/src/main/java/com/thoughtworks/go/config/merge/MergePipelineConfigs.java +++ b/config/config-api/src/main/java/com/thoughtworks/go/config/merge/MergePipelineConfigs.java @@ -26,7 +26,7 @@ import static com.thoughtworks.go.util.ExceptionUtils.bomb; /** - * @understands pipeline group configuration in many parts. + * Understands pipeline group configuration in many parts. *

* Composite of many pipeline configuration parts. */ diff --git a/config/config-api/src/main/java/com/thoughtworks/go/config/pluggabletask/PluggableTask.java b/config/config-api/src/main/java/com/thoughtworks/go/config/pluggabletask/PluggableTask.java index f724080daee..44c11f58a8c 100644 --- a/config/config-api/src/main/java/com/thoughtworks/go/config/pluggabletask/PluggableTask.java +++ b/config/config-api/src/main/java/com/thoughtworks/go/config/pluggabletask/PluggableTask.java @@ -34,10 +34,13 @@ import org.apache.commons.lang3.StringUtils; import javax.annotation.PostConstruct; -import java.util.*; +import java.util.ArrayList; +import java.util.HashMap; +import java.util.List; +import java.util.Map; /** - * @understands configuration of pluggable task + * Understands configuration of pluggable task */ @ConfigTag("task") public class PluggableTask extends AbstractTask { diff --git a/config/config-api/src/main/java/com/thoughtworks/go/config/preprocessor/ConfigParamPreprocessor.java b/config/config-api/src/main/java/com/thoughtworks/go/config/preprocessor/ConfigParamPreprocessor.java index a77e18a4404..5684f5542d7 100644 --- a/config/config-api/src/main/java/com/thoughtworks/go/config/preprocessor/ConfigParamPreprocessor.java +++ b/config/config-api/src/main/java/com/thoughtworks/go/config/preprocessor/ConfigParamPreprocessor.java @@ -21,7 +21,7 @@ import com.thoughtworks.go.config.PipelineConfig; /** - * @understands Interpolation of config parameters + * Understands Interpolation of config parameters */ public class ConfigParamPreprocessor implements GoConfigPreprocessor { diff --git a/config/config-api/src/main/java/com/thoughtworks/go/config/preprocessor/ParamHandlerFactory.java b/config/config-api/src/main/java/com/thoughtworks/go/config/preprocessor/ParamHandlerFactory.java index 779f0f5b2bd..a1ba9ea8c92 100644 --- a/config/config-api/src/main/java/com/thoughtworks/go/config/preprocessor/ParamHandlerFactory.java +++ b/config/config-api/src/main/java/com/thoughtworks/go/config/preprocessor/ParamHandlerFactory.java @@ -18,7 +18,7 @@ import com.thoughtworks.go.config.ParamsConfig; /** - * @understands creating a com.thoughtworks.go.config.preprocessor.ParamHandler + * Understands creating a com.thoughtworks.go.config.preprocessor.ParamHandler */ public interface ParamHandlerFactory { ParamHandler createHandler(Object resolvable, String fieldName, String stringToResolve); diff --git a/config/config-api/src/main/java/com/thoughtworks/go/config/preprocessor/ParamReferenceCollectorFactory.java b/config/config-api/src/main/java/com/thoughtworks/go/config/preprocessor/ParamReferenceCollectorFactory.java index be7f922320a..b3b49759e03 100644 --- a/config/config-api/src/main/java/com/thoughtworks/go/config/preprocessor/ParamReferenceCollectorFactory.java +++ b/config/config-api/src/main/java/com/thoughtworks/go/config/preprocessor/ParamReferenceCollectorFactory.java @@ -15,13 +15,13 @@ */ package com.thoughtworks.go.config.preprocessor; +import com.thoughtworks.go.config.ParamsConfig; + import java.util.HashSet; import java.util.Set; -import com.thoughtworks.go.config.ParamsConfig; - /** - * @understands creating reference collecting handler + * Understands creating reference collecting handler */ public class ParamReferenceCollectorFactory implements ParamHandlerFactory { diff --git a/config/config-api/src/main/java/com/thoughtworks/go/config/preprocessor/ParamScope.java b/config/config-api/src/main/java/com/thoughtworks/go/config/preprocessor/ParamScope.java index 9876697d2f3..4844b629ec5 100644 --- a/config/config-api/src/main/java/com/thoughtworks/go/config/preprocessor/ParamScope.java +++ b/config/config-api/src/main/java/com/thoughtworks/go/config/preprocessor/ParamScope.java @@ -15,9 +15,6 @@ */ package com.thoughtworks.go.config.preprocessor; -/** - * @understands - */ public interface ParamScope { ParamResolver applyOver(ParamResolver resolver); } diff --git a/config/config-api/src/main/java/com/thoughtworks/go/config/preprocessor/ParamSubstitutionHandlerFactory.java b/config/config-api/src/main/java/com/thoughtworks/go/config/preprocessor/ParamSubstitutionHandlerFactory.java index ac6afb342df..d52f7954e0b 100644 --- a/config/config-api/src/main/java/com/thoughtworks/go/config/preprocessor/ParamSubstitutionHandlerFactory.java +++ b/config/config-api/src/main/java/com/thoughtworks/go/config/preprocessor/ParamSubstitutionHandlerFactory.java @@ -18,7 +18,7 @@ import com.thoughtworks.go.config.ParamsConfig; /** - * @understands creating com.thoughtworks.go.config.preprocessor.ParamSubstitutionHandler + * Understands creating com.thoughtworks.go.config.preprocessor.ParamSubstitutionHandler */ public class ParamSubstitutionHandlerFactory implements ParamHandlerFactory { diff --git a/config/config-api/src/main/java/com/thoughtworks/go/config/preprocessor/SkipParameterResolution.java b/config/config-api/src/main/java/com/thoughtworks/go/config/preprocessor/SkipParameterResolution.java index 90e48c7503b..e8d6e6675b1 100644 --- a/config/config-api/src/main/java/com/thoughtworks/go/config/preprocessor/SkipParameterResolution.java +++ b/config/config-api/src/main/java/com/thoughtworks/go/config/preprocessor/SkipParameterResolution.java @@ -18,11 +18,11 @@ import java.lang.annotation.Retention; import java.lang.annotation.Target; -import static java.lang.annotation.RetentionPolicy.RUNTIME; import static java.lang.annotation.ElementType.FIELD; +import static java.lang.annotation.RetentionPolicy.RUNTIME; /** - * @understands opt-out declaration for parameter resolution + * Understands opt-out declaration for parameter resolution */ @Retention(RUNTIME) @Target(FIELD) diff --git a/config/config-api/src/main/java/com/thoughtworks/go/config/registry/ConfigElementImplementationRegistry.java b/config/config-api/src/main/java/com/thoughtworks/go/config/registry/ConfigElementImplementationRegistry.java index 011409fe407..a206ae9fe27 100644 --- a/config/config-api/src/main/java/com/thoughtworks/go/config/registry/ConfigElementImplementationRegistry.java +++ b/config/config-api/src/main/java/com/thoughtworks/go/config/registry/ConfigElementImplementationRegistry.java @@ -33,7 +33,7 @@ import java.util.concurrent.ConcurrentMap; /** - * @understands mapping the implementers of a given Config interface. + * Understands mapping the implementers of a given Config interface. */ @Component public class ConfigElementImplementationRegistry implements ConfigElementRegistry { diff --git a/config/config-api/src/main/java/com/thoughtworks/go/config/registry/ConfigElementRegistry.java b/config/config-api/src/main/java/com/thoughtworks/go/config/registry/ConfigElementRegistry.java index bf31e15e274..6bf29b22beb 100644 --- a/config/config-api/src/main/java/com/thoughtworks/go/config/registry/ConfigElementRegistry.java +++ b/config/config-api/src/main/java/com/thoughtworks/go/config/registry/ConfigElementRegistry.java @@ -17,9 +17,6 @@ import java.util.List; -/** - * @understands - */ public interface ConfigElementRegistry { List> implementersOf(Class type); } diff --git a/config/config-api/src/main/java/com/thoughtworks/go/config/registry/PluginNamespace.java b/config/config-api/src/main/java/com/thoughtworks/go/config/registry/PluginNamespace.java index 1e5e47e7415..c9d27ab7b6a 100644 --- a/config/config-api/src/main/java/com/thoughtworks/go/config/registry/PluginNamespace.java +++ b/config/config-api/src/main/java/com/thoughtworks/go/config/registry/PluginNamespace.java @@ -15,15 +15,15 @@ */ package com.thoughtworks.go.config.registry; -import java.net.URL; - import com.thoughtworks.go.plugins.GoPluginManifest; import com.thoughtworks.go.util.GoConstants; import org.osgi.framework.Bundle; import org.osgi.framework.BundleContext; +import java.net.URL; + /** -* @understands the XML namespace that a plugin provides for a given set of config tags +* Understands the XML namespace that a plugin provides for a given set of config tags */ public class PluginNamespace { public static final String XSD_NAMESPACE_PREFIX = GoConstants.GO_PLUGIN_MANIFEST_HEADER_PREFIX + "Xsd-Prefix"; diff --git a/config/config-api/src/main/java/com/thoughtworks/go/config/remote/ConfigOrigin.java b/config/config-api/src/main/java/com/thoughtworks/go/config/remote/ConfigOrigin.java index 43e7347c9bb..1ec5e37a810 100644 --- a/config/config-api/src/main/java/com/thoughtworks/go/config/remote/ConfigOrigin.java +++ b/config/config-api/src/main/java/com/thoughtworks/go/config/remote/ConfigOrigin.java @@ -16,7 +16,7 @@ package com.thoughtworks.go.config.remote; /** - * @understands where configuration comes from. + * Understands where configuration comes from. */ public interface ConfigOrigin { /** diff --git a/config/config-api/src/main/java/com/thoughtworks/go/config/remote/FileConfigOrigin.java b/config/config-api/src/main/java/com/thoughtworks/go/config/remote/FileConfigOrigin.java index 3ea5607993f..e89bc61ee7f 100644 --- a/config/config-api/src/main/java/com/thoughtworks/go/config/remote/FileConfigOrigin.java +++ b/config/config-api/src/main/java/com/thoughtworks/go/config/remote/FileConfigOrigin.java @@ -16,7 +16,7 @@ package com.thoughtworks.go.config.remote; /** - * @understands that configuration is defined in a locally available file. + * Understands that configuration is defined in a locally available file. */ public class FileConfigOrigin implements ConfigOrigin { diff --git a/config/config-api/src/main/java/com/thoughtworks/go/config/remote/RepoConfigOrigin.java b/config/config-api/src/main/java/com/thoughtworks/go/config/remote/RepoConfigOrigin.java index eb5c8c275e2..26ff9ac5f38 100644 --- a/config/config-api/src/main/java/com/thoughtworks/go/config/remote/RepoConfigOrigin.java +++ b/config/config-api/src/main/java/com/thoughtworks/go/config/remote/RepoConfigOrigin.java @@ -20,7 +20,7 @@ import java.util.Objects; /** - * @understands that configuration is defined in versioned source code repository at particular revision. + * Understands that configuration is defined in versioned source code repository at particular revision. */ public class RepoConfigOrigin implements ConfigOrigin { diff --git a/config/config-api/src/main/java/com/thoughtworks/go/config/validation/ServerIdImmutabilityValidator.java b/config/config-api/src/main/java/com/thoughtworks/go/config/validation/ServerIdImmutabilityValidator.java index c30e3f38e60..fa898d3e852 100644 --- a/config/config-api/src/main/java/com/thoughtworks/go/config/validation/ServerIdImmutabilityValidator.java +++ b/config/config-api/src/main/java/com/thoughtworks/go/config/validation/ServerIdImmutabilityValidator.java @@ -20,7 +20,7 @@ import com.thoughtworks.go.util.SystemEnvironment; /** - * @understands: ensures serverId is never changed + * Understands: ensures serverId is never changed */ public class ServerIdImmutabilityValidator implements GoConfigValidator { private String serverId; diff --git a/config/config-api/src/main/java/com/thoughtworks/go/config/validation/TokenGenerationKeyImmutabilityValidator.java b/config/config-api/src/main/java/com/thoughtworks/go/config/validation/TokenGenerationKeyImmutabilityValidator.java index f777ef597d6..fb4670829c0 100644 --- a/config/config-api/src/main/java/com/thoughtworks/go/config/validation/TokenGenerationKeyImmutabilityValidator.java +++ b/config/config-api/src/main/java/com/thoughtworks/go/config/validation/TokenGenerationKeyImmutabilityValidator.java @@ -20,7 +20,7 @@ import com.thoughtworks.go.util.SystemEnvironment; /** - * @understands: ensures tokenGenerationKey is never changed + * Understands: ensures tokenGenerationKey is never changed */ public class TokenGenerationKeyImmutabilityValidator implements GoConfigValidator { private final SystemEnvironment systemEnvironment; diff --git a/config/config-api/src/main/java/com/thoughtworks/go/domain/AgentConfigStatus.java b/config/config-api/src/main/java/com/thoughtworks/go/domain/AgentConfigStatus.java index 787700cab26..99287e81a68 100644 --- a/config/config-api/src/main/java/com/thoughtworks/go/domain/AgentConfigStatus.java +++ b/config/config-api/src/main/java/com/thoughtworks/go/domain/AgentConfigStatus.java @@ -16,7 +16,7 @@ package com.thoughtworks.go.domain; /** - * @understands status of agent based on persistent information + * Understands status of agent based on persistent information */ public enum AgentConfigStatus { Pending, Enabled, Disabled diff --git a/config/config-api/src/main/java/com/thoughtworks/go/domain/EnvironmentPipelineMatcher.java b/config/config-api/src/main/java/com/thoughtworks/go/domain/EnvironmentPipelineMatcher.java index 4d564e412ce..3892c0ba263 100644 --- a/config/config-api/src/main/java/com/thoughtworks/go/domain/EnvironmentPipelineMatcher.java +++ b/config/config-api/src/main/java/com/thoughtworks/go/domain/EnvironmentPipelineMatcher.java @@ -15,13 +15,13 @@ */ package com.thoughtworks.go.domain; -import java.util.List; - import com.thoughtworks.go.config.CaseInsensitiveString; import com.thoughtworks.go.config.EnvironmentPipelinesConfig; +import java.util.List; + /** - * @understands how to reference an logical grouping of machines + * Understands how to reference an logical grouping of machines */ public class EnvironmentPipelineMatcher { private final CaseInsensitiveString name; diff --git a/config/config-api/src/main/java/com/thoughtworks/go/domain/EnvironmentPipelineMatchers.java b/config/config-api/src/main/java/com/thoughtworks/go/domain/EnvironmentPipelineMatchers.java index 377770f4242..f3bbf7dcd70 100644 --- a/config/config-api/src/main/java/com/thoughtworks/go/domain/EnvironmentPipelineMatchers.java +++ b/config/config-api/src/main/java/com/thoughtworks/go/domain/EnvironmentPipelineMatchers.java @@ -18,7 +18,7 @@ import java.util.Collection; /** - * @understands matching job with agents in situations where either, both or none are in environment + * Understands matching job with agents in situations where either, both or none are in environment */ public class EnvironmentPipelineMatchers extends BaseCollection { diff --git a/config/config-api/src/main/java/com/thoughtworks/go/domain/IpAddress.java b/config/config-api/src/main/java/com/thoughtworks/go/domain/IpAddress.java index b1c56ed8322..23ac24f3beb 100644 --- a/config/config-api/src/main/java/com/thoughtworks/go/domain/IpAddress.java +++ b/config/config-api/src/main/java/com/thoughtworks/go/domain/IpAddress.java @@ -21,7 +21,7 @@ import java.net.UnknownHostException; /** - * @understands the network address for a machine + * Understands the network address for a machine */ public class IpAddress implements Comparable { private InetAddress address; diff --git a/config/config-api/src/main/java/com/thoughtworks/go/domain/KillAllChildProcessTask.java b/config/config-api/src/main/java/com/thoughtworks/go/domain/KillAllChildProcessTask.java index cc971790dc2..c9be5322ec1 100644 --- a/config/config-api/src/main/java/com/thoughtworks/go/domain/KillAllChildProcessTask.java +++ b/config/config-api/src/main/java/com/thoughtworks/go/domain/KillAllChildProcessTask.java @@ -15,15 +15,15 @@ */ package com.thoughtworks.go.domain; +import com.thoughtworks.go.config.ValidationContext; +import com.thoughtworks.go.service.TaskFactory; + import java.io.Serializable; import java.util.ArrayList; import java.util.List; -import com.thoughtworks.go.config.ValidationContext; -import com.thoughtworks.go.service.TaskFactory; - /** - * @understands how to get the builder to kill all child processes of the current process + * Understands how to get the builder to kill all child processes of the current process */ public class KillAllChildProcessTask implements Task, Serializable { private final ConfigErrors configErrors = new ConfigErrors(); diff --git a/config/config-api/src/main/java/com/thoughtworks/go/plugins/GoPluginManifest.java b/config/config-api/src/main/java/com/thoughtworks/go/plugins/GoPluginManifest.java index 068f1b57113..5b0ce1085d0 100644 --- a/config/config-api/src/main/java/com/thoughtworks/go/plugins/GoPluginManifest.java +++ b/config/config-api/src/main/java/com/thoughtworks/go/plugins/GoPluginManifest.java @@ -15,17 +15,14 @@ */ package com.thoughtworks.go.plugins; -import java.util.Dictionary; - import com.thoughtworks.go.config.registry.PluginNamespace; import org.apache.commons.lang3.StringUtils; import org.jdom2.Namespace; import org.osgi.framework.Bundle; import org.osgi.framework.Constants; -/** - * @understands: GoPluginManifest - */ +import java.util.Dictionary; + public class GoPluginManifest { private final Dictionary headers; diff --git a/config/config-api/src/main/java/com/thoughtworks/go/plugins/PluginExtensions.java b/config/config-api/src/main/java/com/thoughtworks/go/plugins/PluginExtensions.java index df3a8290cb6..94f7df14f07 100644 --- a/config/config-api/src/main/java/com/thoughtworks/go/plugins/PluginExtensions.java +++ b/config/config-api/src/main/java/com/thoughtworks/go/plugins/PluginExtensions.java @@ -15,12 +15,12 @@ */ package com.thoughtworks.go.plugins; -import java.util.List; - import com.thoughtworks.go.config.registry.ConfigurationExtension; +import java.util.List; + /** - * @understands extensions that plugins provide and exposes them to Go services + * Understands extensions that plugins provide and exposes them to Go services */ public interface PluginExtensions { public List configTagImplementations(); diff --git a/config/config-api/src/main/java/com/thoughtworks/go/plugins/presentation/BuiltinTaskViewModelFactory.java b/config/config-api/src/main/java/com/thoughtworks/go/plugins/presentation/BuiltinTaskViewModelFactory.java index 2fad3995c0a..b6ccd49ecb3 100644 --- a/config/config-api/src/main/java/com/thoughtworks/go/plugins/presentation/BuiltinTaskViewModelFactory.java +++ b/config/config-api/src/main/java/com/thoughtworks/go/plugins/presentation/BuiltinTaskViewModelFactory.java @@ -22,8 +22,8 @@ import java.util.Map; /** -* @understands creating a view model for a built in task. -*/ + * Understands creating a view model for a built in task. + */ public class BuiltinTaskViewModelFactory implements PluggableViewModelFactory { private Map viewTemplates; diff --git a/config/config-api/src/main/java/com/thoughtworks/go/plugins/presentation/PluggableViewModelFactory.java b/config/config-api/src/main/java/com/thoughtworks/go/plugins/presentation/PluggableViewModelFactory.java index 167c31d2676..d6ba782aa8f 100644 --- a/config/config-api/src/main/java/com/thoughtworks/go/plugins/presentation/PluggableViewModelFactory.java +++ b/config/config-api/src/main/java/com/thoughtworks/go/plugins/presentation/PluggableViewModelFactory.java @@ -16,7 +16,7 @@ package com.thoughtworks.go.plugins.presentation; /** - * @understands creates pluggable view model with given a model + * Understands creates pluggable view model with given a model */ public interface PluggableViewModelFactory { PluggableViewModel viewModelFor(T renderable, String actionName); diff --git a/config/config-api/src/main/java/com/thoughtworks/go/presentation/TaskViewModel.java b/config/config-api/src/main/java/com/thoughtworks/go/presentation/TaskViewModel.java index a8cfe72e11a..5a38b8369a9 100644 --- a/config/config-api/src/main/java/com/thoughtworks/go/presentation/TaskViewModel.java +++ b/config/config-api/src/main/java/com/thoughtworks/go/presentation/TaskViewModel.java @@ -22,7 +22,7 @@ import java.util.Map; /** - * @understands information required to display a task + * Understands information required to display a task */ public class TaskViewModel implements PluggableViewModel { private String templatePath; diff --git a/config/config-api/src/main/java/com/thoughtworks/go/service/TaskFactory.java b/config/config-api/src/main/java/com/thoughtworks/go/service/TaskFactory.java index 4ac8834b197..729cb5ca1e4 100644 --- a/config/config-api/src/main/java/com/thoughtworks/go/service/TaskFactory.java +++ b/config/config-api/src/main/java/com/thoughtworks/go/service/TaskFactory.java @@ -17,9 +17,6 @@ import com.thoughtworks.go.domain.Task; -/** - * @understands: TaskFactory - */ public interface TaskFactory { Task taskInstanceFor(String type); } diff --git a/config/config-api/src/main/java/com/thoughtworks/go/util/command/EnvironmentVariableContext.java b/config/config-api/src/main/java/com/thoughtworks/go/util/command/EnvironmentVariableContext.java index bf9914657b4..8121d116c2b 100644 --- a/config/config-api/src/main/java/com/thoughtworks/go/util/command/EnvironmentVariableContext.java +++ b/config/config-api/src/main/java/com/thoughtworks/go/util/command/EnvironmentVariableContext.java @@ -25,7 +25,7 @@ import static java.lang.String.format; /** - * @understands a set of variables to be passed to the Agent for a job + * Understands a set of variables to be passed to the Agent for a job */ public class EnvironmentVariableContext implements Serializable, SecretParamAware { diff --git a/config/config-api/src/test/java/com/thoughtworks/go/config/domain/VariableValueConfigTest.java b/config/config-api/src/test/java/com/thoughtworks/go/config/domain/VariableValueConfigTest.java index 609f414272f..aafb6f6d14f 100644 --- a/config/config-api/src/test/java/com/thoughtworks/go/config/domain/VariableValueConfigTest.java +++ b/config/config-api/src/test/java/com/thoughtworks/go/config/domain/VariableValueConfigTest.java @@ -18,12 +18,9 @@ import com.thoughtworks.go.config.VariableValueConfig; import org.junit.jupiter.api.Test; -import static org.hamcrest.Matchers.is; import static org.hamcrest.MatcherAssert.assertThat; +import static org.hamcrest.Matchers.is; -/** - * @understands - */ public class VariableValueConfigTest { @Test public void shouldBeEqualIfValuesAreEqual(){ diff --git a/config/config-api/src/test/java/com/thoughtworks/go/plugins/PluginTestUtil.java b/config/config-api/src/test/java/com/thoughtworks/go/plugins/PluginTestUtil.java index 7d306acd3b1..53e55cebc8d 100644 --- a/config/config-api/src/test/java/com/thoughtworks/go/plugins/PluginTestUtil.java +++ b/config/config-api/src/test/java/com/thoughtworks/go/plugins/PluginTestUtil.java @@ -15,18 +15,15 @@ */ package com.thoughtworks.go.plugins; -import java.util.Hashtable; -import java.util.Map; - import org.osgi.framework.Bundle; import org.osgi.framework.BundleContext; +import java.util.Hashtable; +import java.util.Map; + import static org.mockito.Mockito.mock; import static org.mockito.Mockito.when; -/** - * @understands: PluginTestUtil - */ public class PluginTestUtil { public static BundleContext bundleCtxWithHeaders(Map headerMap) { BundleContext bundleCtx = mock(BundleContext.class); diff --git a/config/config-server/src/main/java/com/thoughtworks/go/config/GoConfigMigration.java b/config/config-server/src/main/java/com/thoughtworks/go/config/GoConfigMigration.java index 4e65303cc4f..aa6d3dec511 100644 --- a/config/config-server/src/main/java/com/thoughtworks/go/config/GoConfigMigration.java +++ b/config/config-server/src/main/java/com/thoughtworks/go/config/GoConfigMigration.java @@ -44,7 +44,7 @@ import static com.thoughtworks.go.util.XmlUtils.buildXmlDocument; /** - * @understands how to migrate from a previous version of config + * Understands how to migrate from a previous version of config */ @Component public class GoConfigMigration { diff --git a/config/config-server/src/main/java/com/thoughtworks/go/config/exceptions/ConfigFileHasChangedException.java b/config/config-server/src/main/java/com/thoughtworks/go/config/exceptions/ConfigFileHasChangedException.java index 972f614eeea..b982bb7e6a6 100644 --- a/config/config-server/src/main/java/com/thoughtworks/go/config/exceptions/ConfigFileHasChangedException.java +++ b/config/config-server/src/main/java/com/thoughtworks/go/config/exceptions/ConfigFileHasChangedException.java @@ -16,7 +16,7 @@ package com.thoughtworks.go.config.exceptions; /** - * @understands the condition when the config file change failed because it has already been changed by someone else + * Understands the condition when the config file change failed because it has already been changed by someone else */ public class ConfigFileHasChangedException extends RuntimeException { public static final String CONFIG_CHANGED_PLEASE_REFRESH = "Configuration file has been modified by someone else."; diff --git a/config/config-server/src/main/java/com/thoughtworks/go/plugins/presentation/PluggableTaskViewModelFactory.java b/config/config-server/src/main/java/com/thoughtworks/go/plugins/presentation/PluggableTaskViewModelFactory.java index 266a011cb14..5f7c2e0cbc9 100644 --- a/config/config-server/src/main/java/com/thoughtworks/go/plugins/presentation/PluggableTaskViewModelFactory.java +++ b/config/config-server/src/main/java/com/thoughtworks/go/plugins/presentation/PluggableTaskViewModelFactory.java @@ -35,7 +35,7 @@ import static java.nio.charset.StandardCharsets.UTF_8; /** - * @understands creating a view model for a pluggable task. + * Understands creating a view model for a pluggable task. */ public class PluggableTaskViewModelFactory implements PluggableViewModelFactory { diff --git a/config/config-server/src/main/java/com/thoughtworks/go/service/ConfigRepository.java b/config/config-server/src/main/java/com/thoughtworks/go/service/ConfigRepository.java index 858db01bcea..688a8601f18 100644 --- a/config/config-server/src/main/java/com/thoughtworks/go/service/ConfigRepository.java +++ b/config/config-server/src/main/java/com/thoughtworks/go/service/ConfigRepository.java @@ -54,7 +54,7 @@ import static java.nio.charset.StandardCharsets.UTF_8; /** - * @understands versioning cruise-config + * Understands versioning cruise-config */ @Component public class ConfigRepository { diff --git a/config/config-server/src/test/java/com/thoughtworks/go/config/serialization/CruiseConfigTest.java b/config/config-server/src/test/java/com/thoughtworks/go/config/serialization/CruiseConfigTest.java index 7687bd6616a..534b5f6d369 100644 --- a/config/config-server/src/test/java/com/thoughtworks/go/config/serialization/CruiseConfigTest.java +++ b/config/config-server/src/test/java/com/thoughtworks/go/config/serialization/CruiseConfigTest.java @@ -21,13 +21,10 @@ import com.thoughtworks.go.util.ConfigElementImplementationRegistryMother; import org.junit.jupiter.api.Test; +import static org.hamcrest.MatcherAssert.assertThat; import static org.hamcrest.Matchers.hasItem; import static org.hamcrest.Matchers.is; -import static org.hamcrest.MatcherAssert.assertThat; -/** - * @understands - */ public class CruiseConfigTest { @Test public void shouldFindAllResourcesOnAllJobs() throws Exception { diff --git a/development-utility/development-agent/src/main/java/com/thoughtworks/go/agent/DevelopmentAgent.java b/development-utility/development-agent/src/main/java/com/thoughtworks/go/agent/DevelopmentAgent.java index d2cf63e6145..5ebcf6978dc 100644 --- a/development-utility/development-agent/src/main/java/com/thoughtworks/go/agent/DevelopmentAgent.java +++ b/development-utility/development-agent/src/main/java/com/thoughtworks/go/agent/DevelopmentAgent.java @@ -19,7 +19,7 @@ import com.thoughtworks.go.util.command.ProcessRunner; /** - * @understands how to run a local development mode agent so we can develop live + * Understands how to run a local development mode agent so we can develop live * Set the following before running the main method: * Working directory: /agent * VM arguments: -Djava.awt.headless=true diff --git a/development-utility/development-server/src/main/java/com/thoughtworks/go/server/DevelopmentServer.java b/development-utility/development-server/src/main/java/com/thoughtworks/go/server/DevelopmentServer.java index fe9e590d986..99e4b70978f 100644 --- a/development-utility/development-server/src/main/java/com/thoughtworks/go/server/DevelopmentServer.java +++ b/development-utility/development-server/src/main/java/com/thoughtworks/go/server/DevelopmentServer.java @@ -27,7 +27,7 @@ import static org.hibernate.cfg.Environment.GENERATE_STATISTICS; /** - * @understands how to run a local development mode webserver so we can develop live + * Understands how to run a local development mode webserver so we can develop live * Set the following before running the main method: * Working directory: /server * VM arguments: diff --git a/domain/src/main/java/com/thoughtworks/go/config/materials/AbstractMaterial.java b/domain/src/main/java/com/thoughtworks/go/config/materials/AbstractMaterial.java index aff8b78e724..0d0d5f19df8 100644 --- a/domain/src/main/java/com/thoughtworks/go/config/materials/AbstractMaterial.java +++ b/domain/src/main/java/com/thoughtworks/go/config/materials/AbstractMaterial.java @@ -32,7 +32,7 @@ import static java.nio.charset.StandardCharsets.UTF_8; /** - * @understands material configuration + * Understands material configuration */ public abstract class AbstractMaterial extends PersistentObject implements Material { /** diff --git a/domain/src/main/java/com/thoughtworks/go/config/materials/ScmMaterial.java b/domain/src/main/java/com/thoughtworks/go/config/materials/ScmMaterial.java index 225c269455f..c8776d9ccaa 100644 --- a/domain/src/main/java/com/thoughtworks/go/config/materials/ScmMaterial.java +++ b/domain/src/main/java/com/thoughtworks/go/config/materials/ScmMaterial.java @@ -36,7 +36,7 @@ /** - * @understands a source control repository and its configuration + * Understands a source control repository and its configuration */ public abstract class ScmMaterial extends AbstractMaterial implements SecretParamAware { diff --git a/domain/src/main/java/com/thoughtworks/go/config/materials/SubprocessExecutionContext.java b/domain/src/main/java/com/thoughtworks/go/config/materials/SubprocessExecutionContext.java index f65a5e339da..9e3031d022c 100644 --- a/domain/src/main/java/com/thoughtworks/go/config/materials/SubprocessExecutionContext.java +++ b/domain/src/main/java/com/thoughtworks/go/config/materials/SubprocessExecutionContext.java @@ -18,7 +18,7 @@ import java.util.Map; /** - * @understands environmental information of process performing material update + * Understands environmental information of process performing material update */ public interface SubprocessExecutionContext { String getProcessNamespace(String fingerprint); diff --git a/domain/src/main/java/com/thoughtworks/go/config/materials/mercurial/HgMaterial.java b/domain/src/main/java/com/thoughtworks/go/config/materials/mercurial/HgMaterial.java index b46246ead29..67c44c0ee93 100644 --- a/domain/src/main/java/com/thoughtworks/go/config/materials/mercurial/HgMaterial.java +++ b/domain/src/main/java/com/thoughtworks/go/config/materials/mercurial/HgMaterial.java @@ -50,7 +50,7 @@ import static org.apache.commons.lang3.StringUtils.isNotBlank; /** - * @understands configuration for mercurial version control + * Understands configuration for mercurial version control */ public class HgMaterial extends ScmMaterial implements PasswordAwareMaterial { private static final Logger LOGGER = LoggerFactory.getLogger(HgMaterial.class); diff --git a/domain/src/main/java/com/thoughtworks/go/config/materials/svn/SvnMaterial.java b/domain/src/main/java/com/thoughtworks/go/config/materials/svn/SvnMaterial.java index 32bbde2498a..fe95f8567bd 100644 --- a/domain/src/main/java/com/thoughtworks/go/config/materials/svn/SvnMaterial.java +++ b/domain/src/main/java/com/thoughtworks/go/config/materials/svn/SvnMaterial.java @@ -43,7 +43,7 @@ import static java.lang.String.format; /** - * @understands configuration for subversion + * Understands configuration for subversion */ public class SvnMaterial extends ScmMaterial implements PasswordEncrypter, PasswordAwareMaterial { private static final Logger LOGGER = LoggerFactory.getLogger(SvnMaterial.class); diff --git a/domain/src/main/java/com/thoughtworks/go/domain/CannotScheduleException.java b/domain/src/main/java/com/thoughtworks/go/domain/CannotScheduleException.java index f870574a2ea..069a49976d6 100644 --- a/domain/src/main/java/com/thoughtworks/go/domain/CannotScheduleException.java +++ b/domain/src/main/java/com/thoughtworks/go/domain/CannotScheduleException.java @@ -16,7 +16,7 @@ package com.thoughtworks.go.domain; /** - * @understands why a stage cannot be scheduled + * Understands why a stage cannot be scheduled */ public class CannotScheduleException extends RuntimeException { private final String stageName; diff --git a/domain/src/main/java/com/thoughtworks/go/domain/DefaultSchedulingContext.java b/domain/src/main/java/com/thoughtworks/go/domain/DefaultSchedulingContext.java index 70052f6ed14..12f994889ec 100644 --- a/domain/src/main/java/com/thoughtworks/go/domain/DefaultSchedulingContext.java +++ b/domain/src/main/java/com/thoughtworks/go/domain/DefaultSchedulingContext.java @@ -26,7 +26,7 @@ import java.util.Map; /** - * @understands what a job needs to know to be scheduled + * Understands what a job needs to know to be scheduled */ public class DefaultSchedulingContext implements SchedulingContext { private final String approvedBy; diff --git a/domain/src/main/java/com/thoughtworks/go/domain/JobPlan.java b/domain/src/main/java/com/thoughtworks/go/domain/JobPlan.java index d0762625ef2..7fd1d09cd95 100644 --- a/domain/src/main/java/com/thoughtworks/go/domain/JobPlan.java +++ b/domain/src/main/java/com/thoughtworks/go/domain/JobPlan.java @@ -23,7 +23,7 @@ import java.util.List; /** - * @understands how to perform a job. This is the persistent version of the JobConfig + * Understands how to perform a job. This is the persistent version of the JobConfig */ public interface JobPlan extends Serializable { String getPipelineName(); diff --git a/domain/src/main/java/com/thoughtworks/go/domain/JobType.java b/domain/src/main/java/com/thoughtworks/go/domain/JobType.java index b76d5e45caa..7d816418a64 100644 --- a/domain/src/main/java/com/thoughtworks/go/domain/JobType.java +++ b/domain/src/main/java/com/thoughtworks/go/domain/JobType.java @@ -21,7 +21,7 @@ import com.thoughtworks.go.util.Clock; /** - * @understands how to match job instances associated with different types of JobConfigs + * Understands how to match job instances associated with different types of JobConfigs */ public interface JobType { boolean isInstanceOf(String jobInstanceName, boolean ignoreCase, String jobConfigName); diff --git a/domain/src/main/java/com/thoughtworks/go/domain/RunDuration.java b/domain/src/main/java/com/thoughtworks/go/domain/RunDuration.java index 424ba40a4ce..a2a5ae6eb3c 100644 --- a/domain/src/main/java/com/thoughtworks/go/domain/RunDuration.java +++ b/domain/src/main/java/com/thoughtworks/go/domain/RunDuration.java @@ -21,7 +21,7 @@ import org.joda.time.format.PeriodFormatterBuilder; /** - * @understands the time taken for a stage to complete + * Understands the time taken for a stage to complete */ public abstract class RunDuration { public static final PeriodFormatter PERIOD_FORMATTER = diff --git a/domain/src/main/java/com/thoughtworks/go/domain/RunMultipleInstance.java b/domain/src/main/java/com/thoughtworks/go/domain/RunMultipleInstance.java index 52a3544fd7d..47a51004d29 100644 --- a/domain/src/main/java/com/thoughtworks/go/domain/RunMultipleInstance.java +++ b/domain/src/main/java/com/thoughtworks/go/domain/RunMultipleInstance.java @@ -23,7 +23,7 @@ import java.util.regex.Pattern; /** - * @understands how to match job instances associated with run-multiple-instance Jobs + * Understands how to match job instances associated with run-multiple-instance Jobs */ public class RunMultipleInstance implements JobType { private static final Pattern CONFIG_NAME_PATTERN = Pattern.compile("^(.+?)-" + RunMultipleInstanceJobTypeConfig.MARKER + "-\\d+$"); diff --git a/domain/src/main/java/com/thoughtworks/go/domain/RunOnAllAgents.java b/domain/src/main/java/com/thoughtworks/go/domain/RunOnAllAgents.java index 6b4c1da458d..0e46ac4c2ce 100644 --- a/domain/src/main/java/com/thoughtworks/go/domain/RunOnAllAgents.java +++ b/domain/src/main/java/com/thoughtworks/go/domain/RunOnAllAgents.java @@ -24,7 +24,7 @@ import java.util.regex.Pattern; /** - * @understands how to match job instances associated with run-on-all-agents Jobs + * Understands how to match job instances associated with run-on-all-agents Jobs */ public class RunOnAllAgents implements JobType { private static final Pattern CONFIG_NAME_PATTERN = Pattern.compile("^(.+?)-" + RunOnAllAgentsJobTypeConfig.MARKER + "-\\d+$"); diff --git a/domain/src/main/java/com/thoughtworks/go/domain/SchedulingContext.java b/domain/src/main/java/com/thoughtworks/go/domain/SchedulingContext.java index e3234404dba..d62300ce45f 100644 --- a/domain/src/main/java/com/thoughtworks/go/domain/SchedulingContext.java +++ b/domain/src/main/java/com/thoughtworks/go/domain/SchedulingContext.java @@ -24,7 +24,7 @@ import java.util.Collection; /** - * @understands the context in which jobs are being scheduled + * Understands the context in which jobs are being scheduled */ public interface SchedulingContext { String getApprovedBy(); diff --git a/domain/src/main/java/com/thoughtworks/go/domain/SingleJobInstance.java b/domain/src/main/java/com/thoughtworks/go/domain/SingleJobInstance.java index 895464c42de..430ef9bf48a 100644 --- a/domain/src/main/java/com/thoughtworks/go/domain/SingleJobInstance.java +++ b/domain/src/main/java/com/thoughtworks/go/domain/SingleJobInstance.java @@ -15,16 +15,12 @@ */ package com.thoughtworks.go.domain; -import com.thoughtworks.go.config.CaseInsensitiveString; -import com.thoughtworks.go.config.JobConfig; -import com.thoughtworks.go.config.JobTypeConfig; -import com.thoughtworks.go.config.SingleJobTypeConfig; -import com.thoughtworks.go.config.StageConfig; +import com.thoughtworks.go.config.*; import com.thoughtworks.go.server.service.InstanceFactory; import com.thoughtworks.go.util.Clock; /** - * @understands how to match job instances associated Jobs that have a single instance + * Understands how to match job instances associated Jobs that have a single instance */ public class SingleJobInstance implements JobType { private final JobTypeConfig jobTypeConfig = new SingleJobTypeConfig(); diff --git a/domain/src/main/java/com/thoughtworks/go/domain/buildcause/BuildCause.java b/domain/src/main/java/com/thoughtworks/go/domain/buildcause/BuildCause.java index 04cc2868dbe..d2d23df20dc 100644 --- a/domain/src/main/java/com/thoughtworks/go/domain/buildcause/BuildCause.java +++ b/domain/src/main/java/com/thoughtworks/go/domain/buildcause/BuildCause.java @@ -33,7 +33,7 @@ import java.util.List; /** - * @understands why a pipeline was triggered and what revisions it contains + * Understands why a pipeline was triggered and what revisions it contains */ public class BuildCause implements Serializable { diff --git a/domain/src/main/java/com/thoughtworks/go/domain/buildcause/BuildTrigger.java b/domain/src/main/java/com/thoughtworks/go/domain/buildcause/BuildTrigger.java index dcff1fb34d9..2fded3b6fb3 100644 --- a/domain/src/main/java/com/thoughtworks/go/domain/buildcause/BuildTrigger.java +++ b/domain/src/main/java/com/thoughtworks/go/domain/buildcause/BuildTrigger.java @@ -15,12 +15,12 @@ */ package com.thoughtworks.go.domain.buildcause; -import java.io.Serializable; - import com.thoughtworks.go.domain.MaterialRevisions; +import java.io.Serializable; + /** - * @understands how a pipeline was triggered + * Understands how a pipeline was triggered */ public class BuildTrigger implements Serializable { private String message; diff --git a/domain/src/main/java/com/thoughtworks/go/domain/materials/MatchedRevision.java b/domain/src/main/java/com/thoughtworks/go/domain/materials/MatchedRevision.java index 1024a129154..64b647ab699 100644 --- a/domain/src/main/java/com/thoughtworks/go/domain/materials/MatchedRevision.java +++ b/domain/src/main/java/com/thoughtworks/go/domain/materials/MatchedRevision.java @@ -20,7 +20,7 @@ import java.util.Date; /** - * @understands a material revision which matches a search criteria + * Understands a material revision which matches a search criteria */ public class MatchedRevision { private final String searchString; diff --git a/domain/src/main/java/com/thoughtworks/go/domain/materials/NullRevision.java b/domain/src/main/java/com/thoughtworks/go/domain/materials/NullRevision.java index cbd91ae3e0e..f4ef90f9527 100644 --- a/domain/src/main/java/com/thoughtworks/go/domain/materials/NullRevision.java +++ b/domain/src/main/java/com/thoughtworks/go/domain/materials/NullRevision.java @@ -16,7 +16,7 @@ package com.thoughtworks.go.domain.materials; /** - * @understands revision for null material + * Understands revision for null material */ public class NullRevision implements Revision { @Override diff --git a/domain/src/main/java/com/thoughtworks/go/domain/materials/SCMCommand.java b/domain/src/main/java/com/thoughtworks/go/domain/materials/SCMCommand.java index 4a842f778a2..b17e0601ea8 100644 --- a/domain/src/main/java/com/thoughtworks/go/domain/materials/SCMCommand.java +++ b/domain/src/main/java/com/thoughtworks/go/domain/materials/SCMCommand.java @@ -20,9 +20,6 @@ import com.thoughtworks.go.util.command.ConsoleOutputStreamConsumer; import com.thoughtworks.go.util.command.ConsoleResult; -/** - * @understands: SCMCommand - */ public abstract class SCMCommand { protected String materialFingerprint; diff --git a/domain/src/main/java/com/thoughtworks/go/domain/materials/tfs/TfsCommandFactory.java b/domain/src/main/java/com/thoughtworks/go/domain/materials/tfs/TfsCommandFactory.java index a1aadea6903..4ec4cbf93a6 100644 --- a/domain/src/main/java/com/thoughtworks/go/domain/materials/tfs/TfsCommandFactory.java +++ b/domain/src/main/java/com/thoughtworks/go/domain/materials/tfs/TfsCommandFactory.java @@ -21,7 +21,7 @@ import org.slf4j.LoggerFactory; /** - * @understands: Factory to give appropriate TFS Command + * Understands: Factory to give appropriate TFS Command */ public class TfsCommandFactory { private static final Logger LOGGER = LoggerFactory.getLogger(TfsCommandFactory.class); diff --git a/server/src/main/java/com/thoughtworks/go/config/CachedGoConfig.java b/server/src/main/java/com/thoughtworks/go/config/CachedGoConfig.java index 833d0f99b3c..33cea43dfb5 100644 --- a/server/src/main/java/com/thoughtworks/go/config/CachedGoConfig.java +++ b/server/src/main/java/com/thoughtworks/go/config/CachedGoConfig.java @@ -39,7 +39,7 @@ import static com.thoughtworks.go.util.ExceptionUtils.bomb; /** - * @understands when to reload the config file or other config source + * Understands when to reload the config file or other config source */ @Component public class CachedGoConfig { diff --git a/server/src/main/java/com/thoughtworks/go/config/ConfigModifyingUser.java b/server/src/main/java/com/thoughtworks/go/config/ConfigModifyingUser.java index 46e6db1a89e..7ed197d46d3 100644 --- a/server/src/main/java/com/thoughtworks/go/config/ConfigModifyingUser.java +++ b/server/src/main/java/com/thoughtworks/go/config/ConfigModifyingUser.java @@ -19,7 +19,7 @@ import com.thoughtworks.go.server.newsecurity.utils.SessionUtils; /** - * @understands who modified config for a particular update command + * Understands who modified config for a particular update command */ public class ConfigModifyingUser { private final String userName; diff --git a/server/src/main/java/com/thoughtworks/go/config/GoConfigDao.java b/server/src/main/java/com/thoughtworks/go/config/GoConfigDao.java index 1dd769d3374..f29095a6df7 100644 --- a/server/src/main/java/com/thoughtworks/go/config/GoConfigDao.java +++ b/server/src/main/java/com/thoughtworks/go/config/GoConfigDao.java @@ -36,7 +36,7 @@ import java.util.List; /** - * @understands how to modify the cruise config sources + * Understands how to modify the cruise config sources */ @Component public class GoConfigDao { diff --git a/server/src/main/java/com/thoughtworks/go/config/InvalidConfigMessageRemover.java b/server/src/main/java/com/thoughtworks/go/config/InvalidConfigMessageRemover.java index b369bf81118..ddd7db8d773 100644 --- a/server/src/main/java/com/thoughtworks/go/config/InvalidConfigMessageRemover.java +++ b/server/src/main/java/com/thoughtworks/go/config/InvalidConfigMessageRemover.java @@ -24,7 +24,7 @@ import org.springframework.stereotype.Component; /** - * @understands removing server health message on valid config changes + * Understands removing server health message on valid config changes */ @Component public class InvalidConfigMessageRemover implements ConfigChangedListener { diff --git a/server/src/main/java/com/thoughtworks/go/config/UserAware.java b/server/src/main/java/com/thoughtworks/go/config/UserAware.java index d97b542448f..f7ac4bad4a9 100644 --- a/server/src/main/java/com/thoughtworks/go/config/UserAware.java +++ b/server/src/main/java/com/thoughtworks/go/config/UserAware.java @@ -15,9 +15,6 @@ */ package com.thoughtworks.go.config; -/** - * @understands - */ public interface UserAware { ConfigModifyingUser user(); diff --git a/server/src/main/java/com/thoughtworks/go/domain/activity/JobStatusCache.java b/server/src/main/java/com/thoughtworks/go/domain/activity/JobStatusCache.java index 8fe849e48fd..3babcdb6f8f 100644 --- a/server/src/main/java/com/thoughtworks/go/domain/activity/JobStatusCache.java +++ b/server/src/main/java/com/thoughtworks/go/domain/activity/JobStatusCache.java @@ -29,7 +29,7 @@ import java.util.concurrent.ConcurrentMap; /** - * @understands jobs that are currently in progress + * Understands jobs that are currently in progress */ @Component public class JobStatusCache implements JobStatusListener { diff --git a/server/src/main/java/com/thoughtworks/go/domain/feed/Author.java b/server/src/main/java/com/thoughtworks/go/domain/feed/Author.java index b316caa0e10..1df71b1b7d1 100644 --- a/server/src/main/java/com/thoughtworks/go/domain/feed/Author.java +++ b/server/src/main/java/com/thoughtworks/go/domain/feed/Author.java @@ -19,7 +19,7 @@ import com.thoughtworks.go.domain.materials.Modification; /** -* @understands author of a commit +* Understands author of a commit */ public class Author { private final String name; diff --git a/server/src/main/java/com/thoughtworks/go/domain/feed/FeedEntries.java b/server/src/main/java/com/thoughtworks/go/domain/feed/FeedEntries.java index 723db2f6c9b..ea0dc87a864 100644 --- a/server/src/main/java/com/thoughtworks/go/domain/feed/FeedEntries.java +++ b/server/src/main/java/com/thoughtworks/go/domain/feed/FeedEntries.java @@ -21,7 +21,7 @@ import java.util.List; /** - * @understands a collection of feeds + * Understands a collection of feeds */ public class FeedEntries extends BaseCollection { diff --git a/server/src/main/java/com/thoughtworks/go/domain/feed/FeedEntry.java b/server/src/main/java/com/thoughtworks/go/domain/feed/FeedEntry.java index 91a10a4c930..7661909bb3f 100644 --- a/server/src/main/java/com/thoughtworks/go/domain/feed/FeedEntry.java +++ b/server/src/main/java/com/thoughtworks/go/domain/feed/FeedEntry.java @@ -19,7 +19,7 @@ import java.util.List; /** - * @understands an atom feed entry + * Understands an atom feed entry */ public interface FeedEntry { diff --git a/server/src/main/java/com/thoughtworks/go/domain/feed/stage/StageFeedEntry.java b/server/src/main/java/com/thoughtworks/go/domain/feed/stage/StageFeedEntry.java index ee8bc243044..2483070d7e9 100644 --- a/server/src/main/java/com/thoughtworks/go/domain/feed/stage/StageFeedEntry.java +++ b/server/src/main/java/com/thoughtworks/go/domain/feed/stage/StageFeedEntry.java @@ -26,7 +26,7 @@ import java.util.List; /** - * @understands an atom feed entry + * Understands an atom feed entry */ public class StageFeedEntry implements FeedEntry { private long id; diff --git a/server/src/main/java/com/thoughtworks/go/server/cache/ArtifactCache.java b/server/src/main/java/com/thoughtworks/go/server/cache/ArtifactCache.java index 91ee54ce806..4300ee25983 100644 --- a/server/src/main/java/com/thoughtworks/go/server/cache/ArtifactCache.java +++ b/server/src/main/java/com/thoughtworks/go/server/cache/ArtifactCache.java @@ -25,7 +25,7 @@ import java.util.concurrent.ConcurrentSkipListSet; /** - * @understands serving prepared artifacts and preparing artifact offline + * Understands serving prepared artifacts and preparing artifact offline */ public abstract class ArtifactCache> { protected final ArtifactsDirHolder artifactsDirHolder; diff --git a/server/src/main/java/com/thoughtworks/go/server/cache/GoCache.java b/server/src/main/java/com/thoughtworks/go/server/cache/GoCache.java index 050edf43a5e..2032fc9aa50 100644 --- a/server/src/main/java/com/thoughtworks/go/server/cache/GoCache.java +++ b/server/src/main/java/com/thoughtworks/go/server/cache/GoCache.java @@ -37,7 +37,7 @@ import static com.thoughtworks.go.util.ExceptionUtils.bomb; /** - * understands storing and retrieving objects from an underlying LRU cache + * Understands storing and retrieving objects from an underlying LRU cache */ public class GoCache { public static final String SUB_KEY_DELIMITER = "!_#$#_!"; diff --git a/server/src/main/java/com/thoughtworks/go/server/dao/JobInstanceDao.java b/server/src/main/java/com/thoughtworks/go/server/dao/JobInstanceDao.java index 16f7116d0cb..bf0a424ea92 100644 --- a/server/src/main/java/com/thoughtworks/go/server/dao/JobInstanceDao.java +++ b/server/src/main/java/com/thoughtworks/go/server/dao/JobInstanceDao.java @@ -22,7 +22,7 @@ import java.util.List; /** - * @understands how to retrieve and save jobInstances on the db + * Understands how to retrieve and save jobInstances on the db */ public interface JobInstanceDao { diff --git a/server/src/main/java/com/thoughtworks/go/server/dao/LocalDependencyMaterialSourceDao.java b/server/src/main/java/com/thoughtworks/go/server/dao/LocalDependencyMaterialSourceDao.java index c4107c8c096..2ebd193566e 100644 --- a/server/src/main/java/com/thoughtworks/go/server/dao/LocalDependencyMaterialSourceDao.java +++ b/server/src/main/java/com/thoughtworks/go/server/dao/LocalDependencyMaterialSourceDao.java @@ -15,9 +15,6 @@ */ package com.thoughtworks.go.server.dao; -import java.util.ArrayList; -import java.util.List; - import com.thoughtworks.go.config.CaseInsensitiveString; import com.thoughtworks.go.config.materials.dependency.DependencyMaterial; import com.thoughtworks.go.domain.Stage; @@ -29,8 +26,11 @@ import org.springframework.beans.factory.annotation.Autowired; import org.springframework.stereotype.Component; +import java.util.ArrayList; +import java.util.List; + /** - * @understands fetching modifications from local stages + * Understands fetching modifications from local stages */ @Component public class LocalDependencyMaterialSourceDao implements DependencyMaterialSourceDao { diff --git a/server/src/main/java/com/thoughtworks/go/server/dao/handlers/VariableValueConfigTypeHandlerCallback.java b/server/src/main/java/com/thoughtworks/go/server/dao/handlers/VariableValueConfigTypeHandlerCallback.java index 2064c45999a..10ae8e40c2b 100644 --- a/server/src/main/java/com/thoughtworks/go/server/dao/handlers/VariableValueConfigTypeHandlerCallback.java +++ b/server/src/main/java/com/thoughtworks/go/server/dao/handlers/VariableValueConfigTypeHandlerCallback.java @@ -22,7 +22,7 @@ import java.sql.SQLException; /** - * @understands converting a {@link VariableValueConfig } to a string and back + * Understands converting a {@link VariableValueConfig } to a string and back */ public class VariableValueConfigTypeHandlerCallback extends StringColumnBasedTypeHandler { diff --git a/server/src/main/java/com/thoughtworks/go/server/domain/JobDurationStrategy.java b/server/src/main/java/com/thoughtworks/go/server/domain/JobDurationStrategy.java index 6db50194a36..4059cf5d93e 100644 --- a/server/src/main/java/com/thoughtworks/go/server/domain/JobDurationStrategy.java +++ b/server/src/main/java/com/thoughtworks/go/server/domain/JobDurationStrategy.java @@ -18,7 +18,7 @@ import com.thoughtworks.go.domain.JobInstance; /** - * @understands how to calculate the expected duration of a job + * Understands how to calculate the expected duration of a job */ public interface JobDurationStrategy { diff --git a/server/src/main/java/com/thoughtworks/go/server/domain/PipelineConfigDependencyGraph.java b/server/src/main/java/com/thoughtworks/go/server/domain/PipelineConfigDependencyGraph.java index 9379b954d7c..f1bfe96c5b8 100644 --- a/server/src/main/java/com/thoughtworks/go/server/domain/PipelineConfigDependencyGraph.java +++ b/server/src/main/java/com/thoughtworks/go/server/domain/PipelineConfigDependencyGraph.java @@ -26,7 +26,7 @@ import java.util.*; /** - * @understands configuration of all the upstream pipelines. + * Understands configuration of all the upstream pipelines. */ public class PipelineConfigDependencyGraph { diff --git a/server/src/main/java/com/thoughtworks/go/server/domain/PipelineTimeline.java b/server/src/main/java/com/thoughtworks/go/server/domain/PipelineTimeline.java index 3883c437454..757c8a07f0d 100644 --- a/server/src/main/java/com/thoughtworks/go/server/domain/PipelineTimeline.java +++ b/server/src/main/java/com/thoughtworks/go/server/domain/PipelineTimeline.java @@ -36,7 +36,7 @@ import java.util.concurrent.locks.ReentrantReadWriteLock; /** - * @understands a sorted collection of PipelineMaterialModification + * Understands a sorted collection of PipelineMaterialModification */ @Component public class PipelineTimeline { diff --git a/server/src/main/java/com/thoughtworks/go/server/domain/ServerBackup.java b/server/src/main/java/com/thoughtworks/go/server/domain/ServerBackup.java index 24654ff0313..a31de0e3b6a 100644 --- a/server/src/main/java/com/thoughtworks/go/server/domain/ServerBackup.java +++ b/server/src/main/java/com/thoughtworks/go/server/domain/ServerBackup.java @@ -22,7 +22,7 @@ import java.util.Optional; /** - * @understands A single backup of the server + * Understands A single backup of the server */ @EqualsAndHashCode(callSuper = true) public class ServerBackup extends PersistentObject { diff --git a/server/src/main/java/com/thoughtworks/go/server/domain/xml/JobXmlViewModel.java b/server/src/main/java/com/thoughtworks/go/server/domain/xml/JobXmlViewModel.java index 505ffb01341..8292e2897e0 100644 --- a/server/src/main/java/com/thoughtworks/go/server/domain/xml/JobXmlViewModel.java +++ b/server/src/main/java/com/thoughtworks/go/server/domain/xml/JobXmlViewModel.java @@ -22,7 +22,7 @@ import org.dom4j.dom.DOMElement; /** - * @understands rendering xml representation of Job + * Understands rendering xml representation of Job */ public class JobXmlViewModel implements XmlRepresentable { private final JobInstance jobInstance; diff --git a/server/src/main/java/com/thoughtworks/go/server/domain/xml/PipelineXmlViewModel.java b/server/src/main/java/com/thoughtworks/go/server/domain/xml/PipelineXmlViewModel.java index a01b48de3bf..5147450d0e9 100644 --- a/server/src/main/java/com/thoughtworks/go/server/domain/xml/PipelineXmlViewModel.java +++ b/server/src/main/java/com/thoughtworks/go/server/domain/xml/PipelineXmlViewModel.java @@ -15,9 +15,6 @@ */ package com.thoughtworks.go.server.domain.xml; -import java.util.List; -import java.util.Map; - import com.thoughtworks.go.config.materials.AbstractMaterial; import com.thoughtworks.go.config.materials.PackageMaterial; import com.thoughtworks.go.config.materials.PluggableSCMMaterial; @@ -40,8 +37,11 @@ import org.dom4j.dom.DOMDocument; import org.dom4j.dom.DOMElement; +import java.util.List; +import java.util.Map; + /** - * @understands rendering xml representation of Pipeline + * Understands rendering xml representation of Pipeline */ public class PipelineXmlViewModel implements XmlRepresentable { private final PipelineInstanceModel pipeline; diff --git a/server/src/main/java/com/thoughtworks/go/server/domain/xml/StageXmlViewModel.java b/server/src/main/java/com/thoughtworks/go/server/domain/xml/StageXmlViewModel.java index 84317cd9016..f48ec2d112b 100644 --- a/server/src/main/java/com/thoughtworks/go/server/domain/xml/StageXmlViewModel.java +++ b/server/src/main/java/com/thoughtworks/go/server/domain/xml/StageXmlViewModel.java @@ -15,11 +15,7 @@ */ package com.thoughtworks.go.server.domain.xml; -import com.thoughtworks.go.domain.JobInstance; -import com.thoughtworks.go.domain.Stage; -import com.thoughtworks.go.domain.StageIdentifier; -import com.thoughtworks.go.domain.XmlRepresentable; -import com.thoughtworks.go.domain.XmlWriterContext; +import com.thoughtworks.go.domain.*; import com.thoughtworks.go.util.DateUtils; import org.dom4j.Document; import org.dom4j.Element; @@ -27,7 +23,7 @@ import org.dom4j.dom.DOMElement; /** - * @understands rendering xml representation of Stage + * Understands rendering xml representation of Stage */ public class StageXmlViewModel implements XmlRepresentable { private final Stage stage; diff --git a/server/src/main/java/com/thoughtworks/go/server/materials/ConfigMaterialPostUpdateQueue.java b/server/src/main/java/com/thoughtworks/go/server/materials/ConfigMaterialPostUpdateQueue.java index d37893a314d..76c768d7954 100644 --- a/server/src/main/java/com/thoughtworks/go/server/materials/ConfigMaterialPostUpdateQueue.java +++ b/server/src/main/java/com/thoughtworks/go/server/materials/ConfigMaterialPostUpdateQueue.java @@ -21,7 +21,7 @@ import org.springframework.stereotype.Component; /** - * @understands messages about completed config material updates + * Understands messages about completed config material updates */ @Component public class ConfigMaterialPostUpdateQueue extends GoMessageQueue { diff --git a/server/src/main/java/com/thoughtworks/go/server/materials/ConfigMaterialUpdateCompletedTopic.java b/server/src/main/java/com/thoughtworks/go/server/materials/ConfigMaterialUpdateCompletedTopic.java index f3090ada1e0..cde51d92017 100644 --- a/server/src/main/java/com/thoughtworks/go/server/materials/ConfigMaterialUpdateCompletedTopic.java +++ b/server/src/main/java/com/thoughtworks/go/server/materials/ConfigMaterialUpdateCompletedTopic.java @@ -21,7 +21,7 @@ import org.springframework.stereotype.Component; /** - * @understands when a config material update has completed + * Understands when a config material update has completed */ @Component public class ConfigMaterialUpdateCompletedTopic extends GoMessageTopic { diff --git a/server/src/main/java/com/thoughtworks/go/server/materials/ConfigMaterialUpdateQueue.java b/server/src/main/java/com/thoughtworks/go/server/materials/ConfigMaterialUpdateQueue.java index 716622060f6..c80f8f2490a 100644 --- a/server/src/main/java/com/thoughtworks/go/server/materials/ConfigMaterialUpdateQueue.java +++ b/server/src/main/java/com/thoughtworks/go/server/materials/ConfigMaterialUpdateQueue.java @@ -21,7 +21,7 @@ import org.springframework.stereotype.Component; /** - * @understands messages about required material updates + * Understands messages about required material updates */ @Component public class ConfigMaterialUpdateQueue extends GoMessageQueue { diff --git a/server/src/main/java/com/thoughtworks/go/server/materials/DependencyMaterialUpdateQueue.java b/server/src/main/java/com/thoughtworks/go/server/materials/DependencyMaterialUpdateQueue.java index 843eb765e08..88e91cc4ae0 100644 --- a/server/src/main/java/com/thoughtworks/go/server/materials/DependencyMaterialUpdateQueue.java +++ b/server/src/main/java/com/thoughtworks/go/server/materials/DependencyMaterialUpdateQueue.java @@ -21,7 +21,7 @@ import org.springframework.stereotype.Component; /** - * @understands messages about required dependency material updates + * Understands messages about required dependency material updates */ @Component public class DependencyMaterialUpdateQueue extends GoMessageQueue { diff --git a/server/src/main/java/com/thoughtworks/go/server/materials/LegacyMaterialChecker.java b/server/src/main/java/com/thoughtworks/go/server/materials/LegacyMaterialChecker.java index f58501013e7..292abbf67fa 100644 --- a/server/src/main/java/com/thoughtworks/go/server/materials/LegacyMaterialChecker.java +++ b/server/src/main/java/com/thoughtworks/go/server/materials/LegacyMaterialChecker.java @@ -15,9 +15,6 @@ */ package com.thoughtworks.go.server.materials; -import java.io.File; -import java.util.List; - import com.thoughtworks.go.config.materials.SubprocessExecutionContext; import com.thoughtworks.go.domain.MaterialRevision; import com.thoughtworks.go.domain.materials.Material; @@ -26,8 +23,11 @@ import org.springframework.beans.factory.annotation.Autowired; import org.springframework.stereotype.Component; +import java.io.File; +import java.util.List; + /** - * @understands how to find modifications for materials using the SCM directly + * Understands how to find modifications for materials using the SCM directly */ @Component public class LegacyMaterialChecker implements ModificationSource { diff --git a/server/src/main/java/com/thoughtworks/go/server/materials/MaterialChecker.java b/server/src/main/java/com/thoughtworks/go/server/materials/MaterialChecker.java index 523c2121aee..10fcce72f06 100644 --- a/server/src/main/java/com/thoughtworks/go/server/materials/MaterialChecker.java +++ b/server/src/main/java/com/thoughtworks/go/server/materials/MaterialChecker.java @@ -15,8 +15,6 @@ */ package com.thoughtworks.go.server.materials; -import java.util.List; - import com.thoughtworks.go.config.CaseInsensitiveString; import com.thoughtworks.go.config.materials.Materials; import com.thoughtworks.go.config.materials.ScmMaterial; @@ -31,10 +29,12 @@ import org.springframework.beans.factory.annotation.Autowired; import org.springframework.stereotype.Component; +import java.util.List; + import static java.lang.String.format; /** - * @understands how to retrieve changes on SCMs given a material + * Understands how to retrieve changes on SCMs given a material */ @Component public class MaterialChecker { diff --git a/server/src/main/java/com/thoughtworks/go/server/materials/MaterialDatabaseUpdater.java b/server/src/main/java/com/thoughtworks/go/server/materials/MaterialDatabaseUpdater.java index 0030a5f434f..85dd8baeb26 100644 --- a/server/src/main/java/com/thoughtworks/go/server/materials/MaterialDatabaseUpdater.java +++ b/server/src/main/java/com/thoughtworks/go/server/materials/MaterialDatabaseUpdater.java @@ -46,7 +46,7 @@ import static org.apache.commons.text.StringEscapeUtils.escapeHtml4; /** - * @understands how to update materials on the database from the real SCMs + * Understands how to update materials on the database from the real SCMs */ @Component public class MaterialDatabaseUpdater { diff --git a/server/src/main/java/com/thoughtworks/go/server/materials/MaterialUpdateCompletedMessage.java b/server/src/main/java/com/thoughtworks/go/server/materials/MaterialUpdateCompletedMessage.java index a78f7468265..6e11110e524 100644 --- a/server/src/main/java/com/thoughtworks/go/server/materials/MaterialUpdateCompletedMessage.java +++ b/server/src/main/java/com/thoughtworks/go/server/materials/MaterialUpdateCompletedMessage.java @@ -15,11 +15,11 @@ */ package com.thoughtworks.go.server.materials; -import com.thoughtworks.go.server.messaging.GoMessage; import com.thoughtworks.go.domain.materials.Material; +import com.thoughtworks.go.server.messaging.GoMessage; /** - * @understands when a material update has completed + * Understands when a material update has completed */ public class MaterialUpdateCompletedMessage implements GoMessage { private final Material material; diff --git a/server/src/main/java/com/thoughtworks/go/server/materials/MaterialUpdateCompletedTopic.java b/server/src/main/java/com/thoughtworks/go/server/materials/MaterialUpdateCompletedTopic.java index 07f12231d2c..a3cb4f26448 100644 --- a/server/src/main/java/com/thoughtworks/go/server/materials/MaterialUpdateCompletedTopic.java +++ b/server/src/main/java/com/thoughtworks/go/server/materials/MaterialUpdateCompletedTopic.java @@ -21,7 +21,7 @@ import org.springframework.stereotype.Component; /** - * @understands when a material update has completed + * Understands when a material update has completed */ @Component public class MaterialUpdateCompletedTopic extends GoMessageTopic { diff --git a/server/src/main/java/com/thoughtworks/go/server/materials/MaterialUpdateFailedMessage.java b/server/src/main/java/com/thoughtworks/go/server/materials/MaterialUpdateFailedMessage.java index 04e86a0429f..0180a7f7322 100644 --- a/server/src/main/java/com/thoughtworks/go/server/materials/MaterialUpdateFailedMessage.java +++ b/server/src/main/java/com/thoughtworks/go/server/materials/MaterialUpdateFailedMessage.java @@ -18,7 +18,7 @@ import com.thoughtworks.go.domain.materials.Material; /** - * @understands when a material update failed + * Understands when a material update failed */ public class MaterialUpdateFailedMessage extends MaterialUpdateCompletedMessage { private final String reason; diff --git a/server/src/main/java/com/thoughtworks/go/server/materials/MaterialUpdateListener.java b/server/src/main/java/com/thoughtworks/go/server/materials/MaterialUpdateListener.java index 22a6a3b3a4a..a54d5c11ea9 100644 --- a/server/src/main/java/com/thoughtworks/go/server/materials/MaterialUpdateListener.java +++ b/server/src/main/java/com/thoughtworks/go/server/materials/MaterialUpdateListener.java @@ -27,7 +27,7 @@ import static com.thoughtworks.go.util.ExceptionUtils.bombIf; /** - * @understands when to trigger updates for materials + * Understands when to trigger updates for materials */ public class MaterialUpdateListener implements GoMessageListener { private static final Logger LOGGER = LoggerFactory.getLogger(MaterialUpdateListener.class); diff --git a/server/src/main/java/com/thoughtworks/go/server/materials/MaterialUpdateMessage.java b/server/src/main/java/com/thoughtworks/go/server/materials/MaterialUpdateMessage.java index cf5a92d7b9c..43bf91dd5b9 100644 --- a/server/src/main/java/com/thoughtworks/go/server/materials/MaterialUpdateMessage.java +++ b/server/src/main/java/com/thoughtworks/go/server/materials/MaterialUpdateMessage.java @@ -22,7 +22,7 @@ import static org.apache.commons.lang3.builder.HashCodeBuilder.reflectionHashCode; /** - * @understands what material needs to be updated + * Understands what material needs to be updated */ public class MaterialUpdateMessage implements GoMessage { private final Material material; diff --git a/server/src/main/java/com/thoughtworks/go/server/materials/MaterialUpdateQueue.java b/server/src/main/java/com/thoughtworks/go/server/materials/MaterialUpdateQueue.java index 2e845e0a4ea..ddac0443f37 100644 --- a/server/src/main/java/com/thoughtworks/go/server/materials/MaterialUpdateQueue.java +++ b/server/src/main/java/com/thoughtworks/go/server/materials/MaterialUpdateQueue.java @@ -21,7 +21,7 @@ import org.springframework.stereotype.Component; /** - * @understands messages about required material updates + * Understands messages about required material updates */ @Component public class MaterialUpdateQueue extends GoMessageQueue { diff --git a/server/src/main/java/com/thoughtworks/go/server/materials/MaterialUpdateService.java b/server/src/main/java/com/thoughtworks/go/server/materials/MaterialUpdateService.java index 003b1fe907f..64a135fa097 100644 --- a/server/src/main/java/com/thoughtworks/go/server/materials/MaterialUpdateService.java +++ b/server/src/main/java/com/thoughtworks/go/server/materials/MaterialUpdateService.java @@ -61,7 +61,7 @@ import static com.thoughtworks.go.serverhealth.ServerHealthState.warning; /** - * @understands when to send requests to update a material on the database + * Understands when to send requests to update a material on the database */ @Service public class MaterialUpdateService implements GoMessageListener, ConfigChangedListener { diff --git a/server/src/main/java/com/thoughtworks/go/server/materials/MaterialUpdateSkippedMessage.java b/server/src/main/java/com/thoughtworks/go/server/materials/MaterialUpdateSkippedMessage.java index 4efc74d947e..e1c5be88d65 100644 --- a/server/src/main/java/com/thoughtworks/go/server/materials/MaterialUpdateSkippedMessage.java +++ b/server/src/main/java/com/thoughtworks/go/server/materials/MaterialUpdateSkippedMessage.java @@ -18,7 +18,7 @@ import com.thoughtworks.go.domain.materials.Material; /** - * @understands when a material update has been skipped due to maintenance mode + * Understands when a material update has been skipped due to maintenance mode */ public class MaterialUpdateSkippedMessage extends MaterialUpdateCompletedMessage { public MaterialUpdateSkippedMessage(Material material, long trackingId) { diff --git a/server/src/main/java/com/thoughtworks/go/server/materials/MaterialUpdateSuccessfulMessage.java b/server/src/main/java/com/thoughtworks/go/server/materials/MaterialUpdateSuccessfulMessage.java index 339e7758967..c9b850607a6 100644 --- a/server/src/main/java/com/thoughtworks/go/server/materials/MaterialUpdateSuccessfulMessage.java +++ b/server/src/main/java/com/thoughtworks/go/server/materials/MaterialUpdateSuccessfulMessage.java @@ -18,7 +18,7 @@ import com.thoughtworks.go.domain.materials.Material; /** - * @understands when a material has been updated successfully + * Understands when a material has been updated successfully */ public class MaterialUpdateSuccessfulMessage extends MaterialUpdateCompletedMessage { public MaterialUpdateSuccessfulMessage(Material material, long trackingId) { diff --git a/server/src/main/java/com/thoughtworks/go/server/materials/ModificationSource.java b/server/src/main/java/com/thoughtworks/go/server/materials/ModificationSource.java index 7102054759a..69c1a507c0e 100644 --- a/server/src/main/java/com/thoughtworks/go/server/materials/ModificationSource.java +++ b/server/src/main/java/com/thoughtworks/go/server/materials/ModificationSource.java @@ -15,16 +15,16 @@ */ package com.thoughtworks.go.server.materials; -import java.util.List; -import java.io.File; - import com.thoughtworks.go.config.materials.SubprocessExecutionContext; -import com.thoughtworks.go.domain.materials.Modification; -import com.thoughtworks.go.domain.materials.Material; import com.thoughtworks.go.domain.MaterialRevision; +import com.thoughtworks.go.domain.materials.Material; +import com.thoughtworks.go.domain.materials.Modification; + +import java.io.File; +import java.util.List; /** - * @understands how to find modifications from a meterial using different strategies + * Understands how to find modifications from a meterial using different strategies */ public interface ModificationSource { List findModificationsSince(File workingFolder, Material material, MaterialRevision revision); diff --git a/server/src/main/java/com/thoughtworks/go/server/materials/SpecificMaterialRevisionFactory.java b/server/src/main/java/com/thoughtworks/go/server/materials/SpecificMaterialRevisionFactory.java index 8e9d9131c5f..656a3f66184 100644 --- a/server/src/main/java/com/thoughtworks/go/server/materials/SpecificMaterialRevisionFactory.java +++ b/server/src/main/java/com/thoughtworks/go/server/materials/SpecificMaterialRevisionFactory.java @@ -15,8 +15,6 @@ */ package com.thoughtworks.go.server.materials; -import java.util.Map; - import com.thoughtworks.go.config.CaseInsensitiveString; import com.thoughtworks.go.domain.MaterialRevisions; import com.thoughtworks.go.domain.materials.MaterialConfig; @@ -25,8 +23,10 @@ import org.springframework.beans.factory.annotation.Autowired; import org.springframework.stereotype.Component; +import java.util.Map; + /** - * @understands how to create material revisions from an already known revision + * Understands how to create material revisions from an already known revision */ @Component public class SpecificMaterialRevisionFactory { diff --git a/server/src/main/java/com/thoughtworks/go/server/materials/postcommit/PostCommitHookMaterialType.java b/server/src/main/java/com/thoughtworks/go/server/materials/postcommit/PostCommitHookMaterialType.java index 89c21455ab1..2e4fe632e87 100644 --- a/server/src/main/java/com/thoughtworks/go/server/materials/postcommit/PostCommitHookMaterialType.java +++ b/server/src/main/java/com/thoughtworks/go/server/materials/postcommit/PostCommitHookMaterialType.java @@ -15,9 +15,6 @@ */ package com.thoughtworks.go.server.materials.postcommit; -/** - * @understands: PostCommitHookMaterial - */ public interface PostCommitHookMaterialType { boolean isKnown(); boolean isValid(String type); diff --git a/server/src/main/java/com/thoughtworks/go/server/materials/postcommit/PostCommitHookMaterialTypeResolver.java b/server/src/main/java/com/thoughtworks/go/server/materials/postcommit/PostCommitHookMaterialTypeResolver.java index 9764fabac79..c1ada04d108 100644 --- a/server/src/main/java/com/thoughtworks/go/server/materials/postcommit/PostCommitHookMaterialTypeResolver.java +++ b/server/src/main/java/com/thoughtworks/go/server/materials/postcommit/PostCommitHookMaterialTypeResolver.java @@ -15,17 +15,17 @@ */ package com.thoughtworks.go.server.materials.postcommit; -import java.util.ArrayList; -import java.util.List; - import com.thoughtworks.go.server.materials.postcommit.git.GitPostCommitHookImplementer; import com.thoughtworks.go.server.materials.postcommit.mercurial.MercurialPostCommitHookImplementer; import com.thoughtworks.go.server.materials.postcommit.pluggablescm.PluggableSCMPostCommitHookImplementer; import com.thoughtworks.go.server.materials.postcommit.svn.SvnPostCommitHookImplementer; import org.springframework.stereotype.Component; +import java.util.ArrayList; +import java.util.List; + /** - * @understands: All Materials that can use the post commit hook feature + * Understands: All Materials that can use the post commit hook feature */ @Component public class PostCommitHookMaterialTypeResolver { diff --git a/server/src/main/java/com/thoughtworks/go/server/messaging/ServerBackupQueue.java b/server/src/main/java/com/thoughtworks/go/server/messaging/ServerBackupQueue.java index af39afaeaf1..efc3cb37320 100644 --- a/server/src/main/java/com/thoughtworks/go/server/messaging/ServerBackupQueue.java +++ b/server/src/main/java/com/thoughtworks/go/server/messaging/ServerBackupQueue.java @@ -19,7 +19,7 @@ import org.springframework.stereotype.Component; /** - * @understands messages for initiating server backup + * Understands messages for initiating server backup */ @Component public class ServerBackupQueue extends GoMessageQueue { diff --git a/server/src/main/java/com/thoughtworks/go/server/persistence/AgentDao.java b/server/src/main/java/com/thoughtworks/go/server/persistence/AgentDao.java index b9139b27f5c..d3cdd928d6f 100644 --- a/server/src/main/java/com/thoughtworks/go/server/persistence/AgentDao.java +++ b/server/src/main/java/com/thoughtworks/go/server/persistence/AgentDao.java @@ -46,7 +46,7 @@ import static java.util.stream.Collectors.toList; /** - * @understands persisting and retrieving agent uuid-cookie mapping + * Understands persisting and retrieving agent uuid-cookie mapping */ @SuppressWarnings({"ALL"}) @Component diff --git a/server/src/main/java/com/thoughtworks/go/server/persistence/ArtifactPlanRepository.java b/server/src/main/java/com/thoughtworks/go/server/persistence/ArtifactPlanRepository.java index 5416734ffce..b3063b94475 100644 --- a/server/src/main/java/com/thoughtworks/go/server/persistence/ArtifactPlanRepository.java +++ b/server/src/main/java/com/thoughtworks/go/server/persistence/ArtifactPlanRepository.java @@ -25,7 +25,7 @@ import java.util.List; /** - * @understands persisting and retrieving artifact plan + * Understands persisting and retrieving artifact plan */ @Service public class ArtifactPlanRepository extends HibernateDaoSupport { diff --git a/server/src/main/java/com/thoughtworks/go/server/persistence/PipelineRepository.java b/server/src/main/java/com/thoughtworks/go/server/persistence/PipelineRepository.java index 5ee249cb808..19d2082f172 100644 --- a/server/src/main/java/com/thoughtworks/go/server/persistence/PipelineRepository.java +++ b/server/src/main/java/com/thoughtworks/go/server/persistence/PipelineRepository.java @@ -37,7 +37,7 @@ import java.util.*; /** - * @understands how to store and retrieve piplines from the database + * Understands how to store and retrieve pipelines from the database */ @Component public class PipelineRepository extends HibernateDaoSupport { diff --git a/server/src/main/java/com/thoughtworks/go/server/persistence/ResourceRepository.java b/server/src/main/java/com/thoughtworks/go/server/persistence/ResourceRepository.java index dd002700984..c8958127075 100644 --- a/server/src/main/java/com/thoughtworks/go/server/persistence/ResourceRepository.java +++ b/server/src/main/java/com/thoughtworks/go/server/persistence/ResourceRepository.java @@ -26,7 +26,7 @@ import java.util.List; /** - * @understands persisting and retrieving resource + * Understands persisting and retrieving resource */ @Service public class ResourceRepository extends HibernateDaoSupport { diff --git a/server/src/main/java/com/thoughtworks/go/server/presentation/CanDeleteResult.java b/server/src/main/java/com/thoughtworks/go/server/presentation/CanDeleteResult.java index fca8f1f5e72..c04aef7f68a 100644 --- a/server/src/main/java/com/thoughtworks/go/server/presentation/CanDeleteResult.java +++ b/server/src/main/java/com/thoughtworks/go/server/presentation/CanDeleteResult.java @@ -16,7 +16,7 @@ package com.thoughtworks.go.server.presentation; /** - * @understands being a view model of whether a pipeline can be deleted or not + * Understands being a view model of whether a pipeline can be deleted or not */ public class CanDeleteResult { private final boolean canDelete; diff --git a/server/src/main/java/com/thoughtworks/go/server/scheduling/ScheduleOptions.java b/server/src/main/java/com/thoughtworks/go/server/scheduling/ScheduleOptions.java index a179baf9a33..20796716c09 100644 --- a/server/src/main/java/com/thoughtworks/go/server/scheduling/ScheduleOptions.java +++ b/server/src/main/java/com/thoughtworks/go/server/scheduling/ScheduleOptions.java @@ -24,7 +24,7 @@ import java.util.Map; /** - * @understands parameter object that contains information like revisions and variables with which the pipeline is triggered + * Understands parameter object that contains information like revisions and variables with which the pipeline is triggered */ public class ScheduleOptions { private final Map specifiedRevisions; diff --git a/server/src/main/java/com/thoughtworks/go/server/scheduling/TriggerMonitor.java b/server/src/main/java/com/thoughtworks/go/server/scheduling/TriggerMonitor.java index d952797ec33..d31efdfe963 100644 --- a/server/src/main/java/com/thoughtworks/go/server/scheduling/TriggerMonitor.java +++ b/server/src/main/java/com/thoughtworks/go/server/scheduling/TriggerMonitor.java @@ -15,14 +15,14 @@ */ package com.thoughtworks.go.server.scheduling; -import java.util.concurrent.ConcurrentSkipListSet; - import com.thoughtworks.go.config.CaseInsensitiveString; import com.thoughtworks.go.config.PipelineConfig; import org.springframework.stereotype.Component; +import java.util.concurrent.ConcurrentSkipListSet; + /** - * @understands what is currently being schedule + * Understands what is currently being schedule */ @Component public class TriggerMonitor { diff --git a/server/src/main/java/com/thoughtworks/go/server/security/UserSearchService.java b/server/src/main/java/com/thoughtworks/go/server/security/UserSearchService.java index 0db0ccad436..69bda6b8db2 100644 --- a/server/src/main/java/com/thoughtworks/go/server/security/UserSearchService.java +++ b/server/src/main/java/com/thoughtworks/go/server/security/UserSearchService.java @@ -32,7 +32,7 @@ import java.util.List; /** - * @understands searching for users(from authentication sources) + * Understands searching for users(from authentication sources) */ @Service public class UserSearchService { diff --git a/server/src/main/java/com/thoughtworks/go/server/service/AutoBuild.java b/server/src/main/java/com/thoughtworks/go/server/service/AutoBuild.java index 7adc87a0ec3..3787e27fc59 100644 --- a/server/src/main/java/com/thoughtworks/go/server/service/AutoBuild.java +++ b/server/src/main/java/com/thoughtworks/go/server/service/AutoBuild.java @@ -32,7 +32,7 @@ import org.slf4j.LoggerFactory; /** - * @understands a build that was triggered by a change in some external materials + * Understands a build that was triggered by a change in some external materials */ public class AutoBuild implements BuildType { private final GoConfigService goConfigService; diff --git a/server/src/main/java/com/thoughtworks/go/server/service/BackupService.java b/server/src/main/java/com/thoughtworks/go/server/service/BackupService.java index 42dfa9f0b2c..b8e5bfc3271 100644 --- a/server/src/main/java/com/thoughtworks/go/server/service/BackupService.java +++ b/server/src/main/java/com/thoughtworks/go/server/service/BackupService.java @@ -56,7 +56,7 @@ import static org.apache.commons.lang3.StringUtils.isNotBlank; /** - * @understands backing up db and config + * Understands backing up db and config */ @Service public class BackupService implements BackupStatusProvider { diff --git a/server/src/main/java/com/thoughtworks/go/server/service/BuildAssignmentService.java b/server/src/main/java/com/thoughtworks/go/server/service/BuildAssignmentService.java index 17a96afbd93..93f4c133564 100644 --- a/server/src/main/java/com/thoughtworks/go/server/service/BuildAssignmentService.java +++ b/server/src/main/java/com/thoughtworks/go/server/service/BuildAssignmentService.java @@ -56,7 +56,7 @@ /** - * @understands how to assign work to agents + * Understands how to assign work to agents */ @Service public class BuildAssignmentService implements ConfigChangedListener { diff --git a/server/src/main/java/com/thoughtworks/go/server/service/BuildType.java b/server/src/main/java/com/thoughtworks/go/server/service/BuildType.java index 2eac98f5feb..f1a0defb467 100644 --- a/server/src/main/java/com/thoughtworks/go/server/service/BuildType.java +++ b/server/src/main/java/com/thoughtworks/go/server/service/BuildType.java @@ -22,7 +22,7 @@ import com.thoughtworks.go.serverhealth.ServerHealthService; /** - * @understands builds that are triggered in different ways + * Understands builds that are triggered in different ways */ public interface BuildType { BuildCause onModifications(MaterialRevisions materialRevisions, boolean materialConfigurationChanged, MaterialRevisions previousMaterialRevisions); diff --git a/server/src/main/java/com/thoughtworks/go/server/service/ConfigRepositoryInitializer.java b/server/src/main/java/com/thoughtworks/go/server/service/ConfigRepositoryInitializer.java index 48d840cc811..85edede3886 100644 --- a/server/src/main/java/com/thoughtworks/go/server/service/ConfigRepositoryInitializer.java +++ b/server/src/main/java/com/thoughtworks/go/server/service/ConfigRepositoryInitializer.java @@ -43,7 +43,7 @@ import static com.thoughtworks.go.plugin.domain.common.PluginConstants.CONFIG_REPO_EXTENSION; /** - * @understands initializing config repositories. Loads the configurations from the last checked out modification on server startup. + * Understands initializing config repositories. Loads the configurations from the last checked out modification on server startup. */ @Service public class ConfigRepositoryInitializer implements ConfigChangedListener, PluginChangeListener { diff --git a/server/src/main/java/com/thoughtworks/go/server/service/DiskSpaceChecker.java b/server/src/main/java/com/thoughtworks/go/server/service/DiskSpaceChecker.java index 886a7d7948c..f895132bd33 100644 --- a/server/src/main/java/com/thoughtworks/go/server/service/DiskSpaceChecker.java +++ b/server/src/main/java/com/thoughtworks/go/server/service/DiskSpaceChecker.java @@ -25,7 +25,7 @@ import java.io.IOException; /** - * @understands when disk space is too low to be safe on server + * Understands when disk space is too low to be safe on server */ public abstract class DiskSpaceChecker implements SchedulingChecker { protected final SystemEnvironment systemEnvironment; diff --git a/server/src/main/java/com/thoughtworks/go/server/service/EnvironmentConfigService.java b/server/src/main/java/com/thoughtworks/go/server/service/EnvironmentConfigService.java index 17df0d79edc..4519f87f91f 100644 --- a/server/src/main/java/com/thoughtworks/go/server/service/EnvironmentConfigService.java +++ b/server/src/main/java/com/thoughtworks/go/server/service/EnvironmentConfigService.java @@ -55,7 +55,7 @@ import static java.util.stream.Collectors.toList; /** - * @understands grouping of agents and pipelines within an environment + * Understands grouping of agents and pipelines within an environment */ @Service public class EnvironmentConfigService implements ConfigChangedListener, AgentChangeListener { diff --git a/server/src/main/java/com/thoughtworks/go/server/service/FeedResolver.java b/server/src/main/java/com/thoughtworks/go/server/service/FeedResolver.java index a0f75bd18f4..6e958678f0c 100644 --- a/server/src/main/java/com/thoughtworks/go/server/service/FeedResolver.java +++ b/server/src/main/java/com/thoughtworks/go/server/service/FeedResolver.java @@ -20,7 +20,7 @@ import com.thoughtworks.go.server.service.result.LocalizedOperationResult; /** - * @understands obtaining a resource feed + * Understands obtaining a resource feed */ public interface FeedResolver { FeedEntries feed(Username user, LocalizedOperationResult operationResult); diff --git a/server/src/main/java/com/thoughtworks/go/server/service/JobResolverService.java b/server/src/main/java/com/thoughtworks/go/server/service/JobResolverService.java index 9ed17ef3694..08525a34c11 100644 --- a/server/src/main/java/com/thoughtworks/go/server/service/JobResolverService.java +++ b/server/src/main/java/com/thoughtworks/go/server/service/JobResolverService.java @@ -21,7 +21,7 @@ import org.springframework.stereotype.Service; /** - * @understands resolving actual job in case of copy-for-rerun + * Understands resolving actual job in case of copy-for-rerun */ @Service public class JobResolverService { diff --git a/server/src/main/java/com/thoughtworks/go/server/service/ManualBuild.java b/server/src/main/java/com/thoughtworks/go/server/service/ManualBuild.java index bdaea8fce78..2aa5c4a5eb9 100644 --- a/server/src/main/java/com/thoughtworks/go/server/service/ManualBuild.java +++ b/server/src/main/java/com/thoughtworks/go/server/service/ManualBuild.java @@ -17,17 +17,17 @@ import com.thoughtworks.go.config.CaseInsensitiveString; import com.thoughtworks.go.config.PipelineConfig; +import com.thoughtworks.go.domain.MaterialRevisions; +import com.thoughtworks.go.domain.buildcause.BuildCause; import com.thoughtworks.go.server.domain.Username; import com.thoughtworks.go.server.service.result.OperationResult; -import com.thoughtworks.go.domain.buildcause.BuildCause; -import com.thoughtworks.go.domain.MaterialRevisions; -import com.thoughtworks.go.serverhealth.ServerHealthState; import com.thoughtworks.go.serverhealth.ServerHealthService; +import com.thoughtworks.go.serverhealth.ServerHealthState; import org.slf4j.Logger; import org.slf4j.LoggerFactory; /** - * @understands operations related to a pipeline that was forced + * Understands operations related to a pipeline that was forced */ public class ManualBuild implements BuildType { private static final Logger LOGGER = LoggerFactory.getLogger(ManualBuild.class); diff --git a/server/src/main/java/com/thoughtworks/go/server/service/MaterialConfigService.java b/server/src/main/java/com/thoughtworks/go/server/service/MaterialConfigService.java index bcad1506808..cf0640a0ce6 100644 --- a/server/src/main/java/com/thoughtworks/go/server/service/MaterialConfigService.java +++ b/server/src/main/java/com/thoughtworks/go/server/service/MaterialConfigService.java @@ -33,7 +33,7 @@ import static java.util.stream.Collectors.toList; /** - * @understands providing services around a pipeline configuration + * Understands providing services around a pipeline configuration */ @Service public class MaterialConfigService { diff --git a/server/src/main/java/com/thoughtworks/go/server/service/MaterialService.java b/server/src/main/java/com/thoughtworks/go/server/service/MaterialService.java index 87314e2fca7..618942bbd9d 100644 --- a/server/src/main/java/com/thoughtworks/go/server/service/MaterialService.java +++ b/server/src/main/java/com/thoughtworks/go/server/service/MaterialService.java @@ -56,7 +56,7 @@ import static org.apache.commons.lang3.StringUtils.isBlank; /** - * @understands interactions between material-config, repository and modifications + * Understands interactions between material-config, repository and modifications */ @Service public class MaterialService { diff --git a/server/src/main/java/com/thoughtworks/go/server/service/NoModificationsPresentForDependentMaterialException.java b/server/src/main/java/com/thoughtworks/go/server/service/NoModificationsPresentForDependentMaterialException.java index 957ae7fa7d0..4bad4e550d8 100644 --- a/server/src/main/java/com/thoughtworks/go/server/service/NoModificationsPresentForDependentMaterialException.java +++ b/server/src/main/java/com/thoughtworks/go/server/service/NoModificationsPresentForDependentMaterialException.java @@ -15,9 +15,6 @@ */ package com.thoughtworks.go.server.service; -/** - * @understands: NoModificationsPresentForDependentMaterial - */ public class NoModificationsPresentForDependentMaterialException extends RuntimeException{ public NoModificationsPresentForDependentMaterialException(String stageLocator) { super(String.format("No modifications found for %s. Material Database Update for this instance has not completed.", stageLocator)); diff --git a/server/src/main/java/com/thoughtworks/go/server/service/PipelineConfigService.java b/server/src/main/java/com/thoughtworks/go/server/service/PipelineConfigService.java index 3b103ce0098..8b4afbb7716 100644 --- a/server/src/main/java/com/thoughtworks/go/server/service/PipelineConfigService.java +++ b/server/src/main/java/com/thoughtworks/go/server/service/PipelineConfigService.java @@ -43,7 +43,7 @@ import static com.thoughtworks.go.i18n.LocalizedMessage.saveFailedWithReason; /** - * @understands providing services around a pipeline configuration + * Understands providing services around a pipeline configuration */ @Service public class PipelineConfigService { diff --git a/server/src/main/java/com/thoughtworks/go/server/service/PipelineLockChecker.java b/server/src/main/java/com/thoughtworks/go/server/service/PipelineLockChecker.java index df4bb8e69b6..b50d3e30219 100644 --- a/server/src/main/java/com/thoughtworks/go/server/service/PipelineLockChecker.java +++ b/server/src/main/java/com/thoughtworks/go/server/service/PipelineLockChecker.java @@ -15,14 +15,14 @@ */ package com.thoughtworks.go.server.service; -import static java.lang.String.format; - import com.thoughtworks.go.server.service.result.OperationResult; -import com.thoughtworks.go.serverhealth.HealthStateType; import com.thoughtworks.go.serverhealth.HealthStateScope; +import com.thoughtworks.go.serverhealth.HealthStateType; + +import static java.lang.String.format; /** - * @understands whether a pipeline is locked + * Understands whether a pipeline is locked */ public class PipelineLockChecker implements SchedulingChecker { private final String pipelineName; diff --git a/server/src/main/java/com/thoughtworks/go/server/service/PipelineLockService.java b/server/src/main/java/com/thoughtworks/go/server/service/PipelineLockService.java index cc37523fcb0..5b864cfe67d 100644 --- a/server/src/main/java/com/thoughtworks/go/server/service/PipelineLockService.java +++ b/server/src/main/java/com/thoughtworks/go/server/service/PipelineLockService.java @@ -36,7 +36,7 @@ import java.util.List; /** - * @understands how/whether to lock/unlock a pipeline instance + * Understands how/whether to lock/unlock a pipeline instance */ @Service public class PipelineLockService implements ConfigChangedListener { diff --git a/server/src/main/java/com/thoughtworks/go/server/service/PipelineUnlockApiService.java b/server/src/main/java/com/thoughtworks/go/server/service/PipelineUnlockApiService.java index 35ea38dea65..3577b663215 100644 --- a/server/src/main/java/com/thoughtworks/go/server/service/PipelineUnlockApiService.java +++ b/server/src/main/java/com/thoughtworks/go/server/service/PipelineUnlockApiService.java @@ -28,7 +28,7 @@ import static java.lang.String.format; /** - * @understands forced unlocking of pipeline by a user + * Understands forced unlocking of pipeline by a user *

* unlock belongs in PipelineLockService but had to be pulled into a separate service * because of circular dependency between CachedCurrentActivityService and PipelineLockService diff --git a/server/src/main/java/com/thoughtworks/go/server/service/ScheduledPipelineLoader.java b/server/src/main/java/com/thoughtworks/go/server/service/ScheduledPipelineLoader.java index e3c2ee0c6a9..904c01da4ef 100644 --- a/server/src/main/java/com/thoughtworks/go/server/service/ScheduledPipelineLoader.java +++ b/server/src/main/java/com/thoughtworks/go/server/service/ScheduledPipelineLoader.java @@ -38,7 +38,7 @@ import static com.thoughtworks.go.serverhealth.ServerHealthState.error; /** - * @understands loads scheduled pipeline for creating work + * Understands loads scheduled pipeline for creating work */ @Component public class ScheduledPipelineLoader { diff --git a/server/src/main/java/com/thoughtworks/go/server/service/StageLockChecker.java b/server/src/main/java/com/thoughtworks/go/server/service/StageLockChecker.java index 62de34ef558..181486f4799 100644 --- a/server/src/main/java/com/thoughtworks/go/server/service/StageLockChecker.java +++ b/server/src/main/java/com/thoughtworks/go/server/service/StageLockChecker.java @@ -21,7 +21,7 @@ import com.thoughtworks.go.serverhealth.HealthStateType; /** - * @understands if a Stage can be scheduled in a locked pipeline + * Understands if a Stage can be scheduled in a locked pipeline */ public class StageLockChecker implements SchedulingChecker { private final PipelineIdentifier pipeline; diff --git a/server/src/main/java/com/thoughtworks/go/server/service/TimedBuild.java b/server/src/main/java/com/thoughtworks/go/server/service/TimedBuild.java index 1d790f3a911..b459c8ba0d9 100644 --- a/server/src/main/java/com/thoughtworks/go/server/service/TimedBuild.java +++ b/server/src/main/java/com/thoughtworks/go/server/service/TimedBuild.java @@ -27,7 +27,7 @@ import org.slf4j.LoggerFactory; /** - * @understands builds that are triggered by a timer + * Understands builds that are triggered by a timer */ public class TimedBuild implements BuildType { private static final Logger LOGGER = LoggerFactory.getLogger(TimedBuild.class); diff --git a/server/src/main/java/com/thoughtworks/go/server/service/TimerScheduler.java b/server/src/main/java/com/thoughtworks/go/server/service/TimerScheduler.java index c6c0d307c64..79ed86746bf 100644 --- a/server/src/main/java/com/thoughtworks/go/server/service/TimerScheduler.java +++ b/server/src/main/java/com/thoughtworks/go/server/service/TimerScheduler.java @@ -45,7 +45,7 @@ import static org.quartz.impl.matchers.GroupMatcher.groupEquals; /** - * @understands scheduling pipelines based on a timer + * Understands scheduling pipelines based on a timer */ @Component public class TimerScheduler implements ConfigChangedListener { diff --git a/server/src/main/java/com/thoughtworks/go/server/service/result/DiskSpaceOperationResult.java b/server/src/main/java/com/thoughtworks/go/server/service/result/DiskSpaceOperationResult.java index 19da5789065..c81bf0e24ab 100644 --- a/server/src/main/java/com/thoughtworks/go/server/service/result/DiskSpaceOperationResult.java +++ b/server/src/main/java/com/thoughtworks/go/server/service/result/DiskSpaceOperationResult.java @@ -20,7 +20,7 @@ import com.thoughtworks.go.serverhealth.ServerHealthState; /** - * @understands updating server health information relating to disk space + * Understands updating server health information relating to disk space */ public class DiskSpaceOperationResult implements OperationResult { private final ServerHealthService serverHealthService; diff --git a/server/src/main/java/com/thoughtworks/go/server/service/result/ServerHealthServiceUpdatingOperationResult.java b/server/src/main/java/com/thoughtworks/go/server/service/result/ServerHealthServiceUpdatingOperationResult.java index 8f42f049102..7bea450dede 100644 --- a/server/src/main/java/com/thoughtworks/go/server/service/result/ServerHealthServiceUpdatingOperationResult.java +++ b/server/src/main/java/com/thoughtworks/go/server/service/result/ServerHealthServiceUpdatingOperationResult.java @@ -20,7 +20,7 @@ import com.thoughtworks.go.serverhealth.ServerHealthState; /** - * @understands how to report results of common operations to the user + * Understands how to report results of common operations to the user */ public class ServerHealthServiceUpdatingOperationResult implements OperationResult { diff --git a/server/src/main/java/com/thoughtworks/go/server/service/support/ServerHealthInformationProvider.java b/server/src/main/java/com/thoughtworks/go/server/service/support/ServerHealthInformationProvider.java index 74d24ab4334..70b00f988b0 100644 --- a/server/src/main/java/com/thoughtworks/go/server/service/support/ServerHealthInformationProvider.java +++ b/server/src/main/java/com/thoughtworks/go/server/service/support/ServerHealthInformationProvider.java @@ -26,7 +26,7 @@ import java.util.Map; /** - * @understands Dumping all the server health messages + * Understands Dumping all the server health messages */ @Component public class ServerHealthInformationProvider implements ServerInfoProvider { diff --git a/server/src/main/java/com/thoughtworks/go/server/service/support/ServerInfoProvider.java b/server/src/main/java/com/thoughtworks/go/server/service/support/ServerInfoProvider.java index b4d1d454e00..2ba5b24f018 100644 --- a/server/src/main/java/com/thoughtworks/go/server/service/support/ServerInfoProvider.java +++ b/server/src/main/java/com/thoughtworks/go/server/service/support/ServerInfoProvider.java @@ -19,7 +19,7 @@ import java.util.Map; /** - * @understands appending any information that this provider wants to contribute while collecting the information for the + * Understands appending any information that this provider wants to contribute while collecting the information for the */ public interface ServerInfoProvider { double priority(); diff --git a/server/src/main/java/com/thoughtworks/go/server/ui/AgentViewModel.java b/server/src/main/java/com/thoughtworks/go/server/ui/AgentViewModel.java index fe06fb43cb7..c078a3e913d 100644 --- a/server/src/main/java/com/thoughtworks/go/server/ui/AgentViewModel.java +++ b/server/src/main/java/com/thoughtworks/go/server/ui/AgentViewModel.java @@ -24,7 +24,7 @@ import java.util.*; /** - * @understands agent information for the UI + * Understands agent information for the UI */ public class AgentViewModel implements Comparable{ private final AgentInstance agentInstance; diff --git a/server/src/main/java/com/thoughtworks/go/server/ui/AgentsViewModel.java b/server/src/main/java/com/thoughtworks/go/server/ui/AgentsViewModel.java index 9794dc5e8ec..5db48b14f65 100644 --- a/server/src/main/java/com/thoughtworks/go/server/ui/AgentsViewModel.java +++ b/server/src/main/java/com/thoughtworks/go/server/ui/AgentsViewModel.java @@ -32,7 +32,7 @@ import static org.apache.commons.lang3.StringUtils.isBlank; /** - * @understands collection of agents view model + * Understands collection of agents view model */ public class AgentsViewModel extends BaseCollection { diff --git a/server/src/main/java/com/thoughtworks/go/server/ui/JobInstancesModel.java b/server/src/main/java/com/thoughtworks/go/server/ui/JobInstancesModel.java index eb4f51e3bea..748f64e462e 100644 --- a/server/src/main/java/com/thoughtworks/go/server/ui/JobInstancesModel.java +++ b/server/src/main/java/com/thoughtworks/go/server/ui/JobInstancesModel.java @@ -22,7 +22,7 @@ import java.util.Iterator; /** - * @understands how to represent a paginated list of jobs on the UI + * Understands how to represent a paginated list of jobs on the UI */ public class JobInstancesModel implements Iterable { diff --git a/server/src/main/java/com/thoughtworks/go/server/ui/ModificationForPipeline.java b/server/src/main/java/com/thoughtworks/go/server/ui/ModificationForPipeline.java index 7657192c8b0..210b970492b 100644 --- a/server/src/main/java/com/thoughtworks/go/server/ui/ModificationForPipeline.java +++ b/server/src/main/java/com/thoughtworks/go/server/ui/ModificationForPipeline.java @@ -19,7 +19,7 @@ import com.thoughtworks.go.domain.materials.Modification; /** - * @understands association of material revisions of a pipeline + * Understands association of material revisions of a pipeline */ public class ModificationForPipeline { private final PipelineId pipelineId; diff --git a/server/src/main/java/com/thoughtworks/go/server/ui/PipelineId.java b/server/src/main/java/com/thoughtworks/go/server/ui/PipelineId.java index 5cee5fcb4ac..fd03b664dbf 100644 --- a/server/src/main/java/com/thoughtworks/go/server/ui/PipelineId.java +++ b/server/src/main/java/com/thoughtworks/go/server/ui/PipelineId.java @@ -16,7 +16,7 @@ package com.thoughtworks.go.server.ui; /** - * @understands identifying a pipeline uniquely in both config and db + * Understands identifying a pipeline uniquely in both config and db */ public class PipelineId { private final String pipelineName; diff --git a/server/src/main/java/com/thoughtworks/go/server/ui/SortOrder.java b/server/src/main/java/com/thoughtworks/go/server/ui/SortOrder.java index cfda6650c97..f088bde9b21 100644 --- a/server/src/main/java/com/thoughtworks/go/server/ui/SortOrder.java +++ b/server/src/main/java/com/thoughtworks/go/server/ui/SortOrder.java @@ -17,9 +17,6 @@ import java.util.Comparator; -/** -* @understands sort direction -*/ public enum SortOrder { ASC { @Override diff --git a/server/src/main/java/com/thoughtworks/go/server/ui/StageSummaryModels.java b/server/src/main/java/com/thoughtworks/go/server/ui/StageSummaryModels.java index cc60d7d138d..6df32629898 100644 --- a/server/src/main/java/com/thoughtworks/go/server/ui/StageSummaryModels.java +++ b/server/src/main/java/com/thoughtworks/go/server/ui/StageSummaryModels.java @@ -20,7 +20,7 @@ import com.thoughtworks.go.server.util.Pagination; /** - * @understands how to represent a paginated list of stages with pagination + * Understands how to represent a paginated list of stages with pagination */ public class StageSummaryModels extends BaseCollection { diff --git a/server/src/main/java/com/thoughtworks/go/server/util/LastOperationTime.java b/server/src/main/java/com/thoughtworks/go/server/util/LastOperationTime.java index ef6ef986088..b6128c2f0bb 100644 --- a/server/src/main/java/com/thoughtworks/go/server/util/LastOperationTime.java +++ b/server/src/main/java/com/thoughtworks/go/server/util/LastOperationTime.java @@ -16,7 +16,7 @@ package com.thoughtworks.go.server.util; /** - * @understands when an operation was last performed and how long it needs to wait till it retries + * Understands when an operation was last performed and how long it needs to wait till it retries */ public class LastOperationTime { diff --git a/server/src/main/java/com/thoughtworks/go/server/view/artifacts/ArtifactsView.java b/server/src/main/java/com/thoughtworks/go/server/view/artifacts/ArtifactsView.java index b5292096979..010fbccb170 100644 --- a/server/src/main/java/com/thoughtworks/go/server/view/artifacts/ArtifactsView.java +++ b/server/src/main/java/com/thoughtworks/go/server/view/artifacts/ArtifactsView.java @@ -17,9 +17,6 @@ import org.springframework.web.servlet.ModelAndView; -/** - * @understands - */ public interface ArtifactsView { ModelAndView createView(String filePath, String sha) throws Exception; } diff --git a/server/src/main/java/com/thoughtworks/go/server/view/artifacts/PreparingArtifactFile.java b/server/src/main/java/com/thoughtworks/go/server/view/artifacts/PreparingArtifactFile.java index fdbb080832b..c2d2fca70b5 100644 --- a/server/src/main/java/com/thoughtworks/go/server/view/artifacts/PreparingArtifactFile.java +++ b/server/src/main/java/com/thoughtworks/go/server/view/artifacts/PreparingArtifactFile.java @@ -15,15 +15,12 @@ */ package com.thoughtworks.go.server.view.artifacts; -import java.util.Map; +import org.springframework.web.servlet.view.AbstractView; + import javax.servlet.http.HttpServletRequest; import javax.servlet.http.HttpServletResponse; +import java.util.Map; -import org.springframework.web.servlet.view.AbstractView; - -/** -* @understands -*/ public class PreparingArtifactFile extends AbstractView { @Override protected void renderMergedOutputModel(Map model, HttpServletRequest request, HttpServletResponse response) throws Exception { diff --git a/server/src/main/java/com/thoughtworks/go/server/web/BackupFilter.java b/server/src/main/java/com/thoughtworks/go/server/web/BackupFilter.java index bd52ba1c59a..17f0e1138e5 100644 --- a/server/src/main/java/com/thoughtworks/go/server/web/BackupFilter.java +++ b/server/src/main/java/com/thoughtworks/go/server/web/BackupFilter.java @@ -39,7 +39,7 @@ import static java.nio.charset.StandardCharsets.UTF_8; /** - * @understands redirecting all requests to a service unavailable page when the server is being backed up. + * Understands redirecting all requests to a service unavailable page when the server is being backed up. */ @Component public class BackupFilter extends OncePerRequestFilter { diff --git a/server/src/main/java/com/thoughtworks/go/server/web/FlashLoadingFilter.java b/server/src/main/java/com/thoughtworks/go/server/web/FlashLoadingFilter.java index 16b296513b3..9c1fe1e5961 100644 --- a/server/src/main/java/com/thoughtworks/go/server/web/FlashLoadingFilter.java +++ b/server/src/main/java/com/thoughtworks/go/server/web/FlashLoadingFilter.java @@ -18,14 +18,15 @@ import org.springframework.stereotype.Component; import org.springframework.web.filter.OncePerRequestFilter; -import javax.servlet.*; +import javax.servlet.FilterChain; +import javax.servlet.ServletException; import javax.servlet.http.HttpServletRequest; import javax.servlet.http.HttpServletResponse; import javax.servlet.http.HttpSession; import java.io.IOException; /** - * @understands loading flash object from session + * Understands loading flash object from session */ @Component public class FlashLoadingFilter extends OncePerRequestFilter { diff --git a/server/src/main/java/com/thoughtworks/go/server/web/FlashMessageService.java b/server/src/main/java/com/thoughtworks/go/server/web/FlashMessageService.java index 700858bb387..50129b1003a 100644 --- a/server/src/main/java/com/thoughtworks/go/server/web/FlashMessageService.java +++ b/server/src/main/java/com/thoughtworks/go/server/web/FlashMessageService.java @@ -15,15 +15,15 @@ */ package com.thoughtworks.go.server.web; +import com.thoughtworks.go.presentation.FlashMessageModel; +import org.springframework.stereotype.Service; + import java.util.HashMap; import java.util.Map; import java.util.UUID; -import com.thoughtworks.go.presentation.FlashMessageModel; -import org.springframework.stereotype.Service; - /** - * @understands persisting and retrieving messages from flash(session store, but deleted on read) + * Understands persisting and retrieving messages from flash(session store, but deleted on read) */ @Service public class FlashMessageService { diff --git a/server/src/test-fast/java/com/thoughtworks/go/server/materials/MaterialUpdateFailedMessageTest.java b/server/src/test-fast/java/com/thoughtworks/go/server/materials/MaterialUpdateFailedMessageTest.java index 1f3e98e7138..20e6ebf8365 100644 --- a/server/src/test-fast/java/com/thoughtworks/go/server/materials/MaterialUpdateFailedMessageTest.java +++ b/server/src/test-fast/java/com/thoughtworks/go/server/materials/MaterialUpdateFailedMessageTest.java @@ -19,13 +19,10 @@ import com.thoughtworks.go.helper.MaterialsMother; import org.junit.jupiter.api.Test; -import static org.hamcrest.Matchers.is; import static org.hamcrest.MatcherAssert.assertThat; +import static org.hamcrest.Matchers.is; import static org.mockito.Mockito.mock; -/** - * @understands - */ public class MaterialUpdateFailedMessageTest { @Test diff --git a/server/src/test-fast/java/com/thoughtworks/go/server/service/AutoBuildTriangleDependencyTest.java b/server/src/test-fast/java/com/thoughtworks/go/server/service/AutoBuildTriangleDependencyTest.java index 471969f80e4..85bbef8d959 100644 --- a/server/src/test-fast/java/com/thoughtworks/go/server/service/AutoBuildTriangleDependencyTest.java +++ b/server/src/test-fast/java/com/thoughtworks/go/server/service/AutoBuildTriangleDependencyTest.java @@ -34,9 +34,6 @@ import static org.hamcrest.Matchers.is; import static org.mockito.Mockito.*; -/** - * @understands - */ public class AutoBuildTriangleDependencyTest { private GoConfigService goConfigService; diff --git a/server/src/test-integration/java/com/thoughtworks/go/server/web/HttpTestUtil.java b/server/src/test-integration/java/com/thoughtworks/go/server/web/HttpTestUtil.java index f1b3483bb4d..f54b020dc07 100644 --- a/server/src/test-integration/java/com/thoughtworks/go/server/web/HttpTestUtil.java +++ b/server/src/test-integration/java/com/thoughtworks/go/server/web/HttpTestUtil.java @@ -28,7 +28,7 @@ import java.io.PrintWriter; /** - * @understands test http server that is used to test http client code end-to-end + * Understands test http server that is used to test http client code end-to-end *

* Flicked from https://github.com/test-load-balancer/tlb (pre http-components) e19d4911b089eeaf1a2c */ diff --git a/server/src/test-shared/java/com/thoughtworks/go/util/GoConfigFileHelper.java b/server/src/test-shared/java/com/thoughtworks/go/util/GoConfigFileHelper.java index 63de0383260..9b8444d7a27 100644 --- a/server/src/test-shared/java/com/thoughtworks/go/util/GoConfigFileHelper.java +++ b/server/src/test-shared/java/com/thoughtworks/go/util/GoConfigFileHelper.java @@ -56,7 +56,7 @@ import static org.mockito.Mockito.mock; /** - * @understands how to edit the cruise config file for testing + * Understands how to edit the cruise config file for testing */ public class GoConfigFileHelper { diff --git a/test/test-agent/src/main/java/com/thoughtworks/go/ArgPrintingMain.java b/test/test-agent/src/main/java/com/thoughtworks/go/ArgPrintingMain.java index 466da098402..8b61621befd 100644 --- a/test/test-agent/src/main/java/com/thoughtworks/go/ArgPrintingMain.java +++ b/test/test-agent/src/main/java/com/thoughtworks/go/ArgPrintingMain.java @@ -18,7 +18,7 @@ import java.lang.management.ManagementFactory; /** - * @understands printing arguments for testing purpose and exiting + * Understands printing arguments for testing purpose and exiting */ public class ArgPrintingMain { public static void main(String[] args) { diff --git a/test/test-utils/src/main/java/com/thoughtworks/go/util/SerializationTester.java b/test/test-utils/src/main/java/com/thoughtworks/go/util/SerializationTester.java index 7ed90238cf7..f8ae9dd1d32 100644 --- a/test/test-utils/src/main/java/com/thoughtworks/go/util/SerializationTester.java +++ b/test/test-utils/src/main/java/com/thoughtworks/go/util/SerializationTester.java @@ -18,7 +18,7 @@ import java.io.*; /** - * @understands how to test serialization of classes + * Understands how to test serialization of classes */ public class SerializationTester { @SuppressWarnings("unchecked") diff --git a/util/src/main/java/com/thoughtworks/go/util/DynamicReadWriteLock.java b/util/src/main/java/com/thoughtworks/go/util/DynamicReadWriteLock.java index ee0d6d5fc58..59195aed828 100644 --- a/util/src/main/java/com/thoughtworks/go/util/DynamicReadWriteLock.java +++ b/util/src/main/java/com/thoughtworks/go/util/DynamicReadWriteLock.java @@ -21,7 +21,7 @@ import java.util.concurrent.locks.ReentrantReadWriteLock; /** - * @understands handling of multiple dynamically-created readWriteLocks + * Understands handling of multiple dynamically-created readWriteLocks */ public class DynamicReadWriteLock { private Map locks = new HashMap<>(); diff --git a/util/src/main/java/com/thoughtworks/go/util/VoidThrowingFn.java b/util/src/main/java/com/thoughtworks/go/util/VoidThrowingFn.java index efb4b1e8780..46808a8074f 100644 --- a/util/src/main/java/com/thoughtworks/go/util/VoidThrowingFn.java +++ b/util/src/main/java/com/thoughtworks/go/util/VoidThrowingFn.java @@ -15,9 +15,6 @@ */ package com.thoughtworks.go.util; -/** - * @understands: VoidThrowingFn - */ public abstract class VoidThrowingFn implements ThrowingFn { @Override