diff --git a/README.md b/README.md index 8184dcf7e2..febd01e977 100644 --- a/README.md +++ b/README.md @@ -19,7 +19,7 @@ repositories. - Useful plugins available - Licensed under AGPL-3.0-only -This branch (`develop`) is for the development of SCM-Manager 2.x. If you are interested in the development of version +This branch (`develop`) is for the development of SCM-Manager. If you are interested in the development of version 1.x, please checkout the branch `support/1.x`. ## News diff --git a/build-plugins/src/main/groovy/com/cloudogu/scm/JavaModulePlugin.groovy b/build-plugins/src/main/groovy/com/cloudogu/scm/JavaModulePlugin.groovy index 47c6964c27..08355a0201 100644 --- a/build-plugins/src/main/groovy/com/cloudogu/scm/JavaModulePlugin.groovy +++ b/build-plugins/src/main/groovy/com/cloudogu/scm/JavaModulePlugin.groovy @@ -44,7 +44,7 @@ class JavaModulePlugin implements Plugin { } project.tasks.withType(Javadoc) { - failOnError false + failOnError true } project.sonarqube { diff --git a/docs/de/development/javadoc.md b/docs/de/development/javadoc.md new file mode 100644 index 0000000000..2158cf7799 --- /dev/null +++ b/docs/de/development/javadoc.md @@ -0,0 +1,9 @@ +--- +title: Javadoc +--- + +Die Javadoc finden Sie unter [javadoc](https://scm-manager.org/javadoc/). + +### Entwicklungshinweis +Bitte beachten Sie, dass Fehler (Errors) in Javadoc-Kommentaren zum beabsichtigten Scheitern des Build-Prozesses führen. +Zudem wird dazu geraten, Warnhinweise bei neu hinzugefügten Javadoc-Kommentaren zu vermeiden. diff --git a/docs/de/index.md b/docs/de/index.md index 4f56403336..4900290236 100644 --- a/docs/de/index.md +++ b/docs/de/index.md @@ -1,14 +1,14 @@ --- title: Dokumentation -subtitle: SCM-Manager Dokumentation +subtitle: SCM-Manager-Dokumentation --- Diese Dokumentation beschreibt die Verwaltung und Verwendung vom SCM-Manager. Sie steht in verschiedenen Sprachen und Versionen zur Verfügung, die im Menü rechts ausgewählt werden können. -Der SCM-Manager 2 ist ein extrem leichtgewichtiges Source Code Management-Tool und kann über eine Vielzahl von Plugins individuell erweitert werden. +Der SCM-Manager ist ein extrem leichtgewichtiges Source-Code-Management-Tool und kann über eine Vielzahl von Plugins individuell erweitert werden. Die Dokumentation zum SCM-Manager ist in fünf verschiedene Kategorien unterteilt: -- Der Abschnitt "Erste Schritte" beschreibt die Installation und die Konfiguration des SCM-Managers und beantwortet häufig gestellte Fragen. -- Der Bereich "Administration" handelt von Themen, die beim Betreiben einer Instanz von Belangen sind. -- Unter der Rubrik "Entwicklung" werden alle Informationen zusammengefasst, die für die Weiterentwicklung des SCM-Managers relevant sind. Hierbei wird beschrieben, wie der SCM-Manager gebaut werden kann und was es dabei zu Beachten gilt. -- Der Bereich "Pluginentwicklung" legt den Fokus auf den Prozess eben dieser. -- Unter dem Abschnitt "Anwenderorientiert" werden aus Anwendersicht die Funktionen des SCM-Managers in der Basis-Variante mit dem Mindest-Set an Plugins beschrieben. Die Features der optionalen Plugins werden in separaten Dokumentationen vorgestellt. +- Der Abschnitt „Erste Schritte“ beschreibt die Installation und die Konfiguration des SCM-Managers und beantwortet häufig gestellte Fragen. +- Der Bereich „Administration“ handelt von Themen, die beim Betreiben einer Instanz von Belangen sind. +- Unter der Rubrik „Entwicklung“ werden alle Informationen zusammengefasst, die für die Weiterentwicklung des SCM-Managers relevant sind. Hierbei wird beschrieben, wie der SCM-Manager gebaut werden kann und was es dabei zu beachten gilt. +- Der Bereich „Pluginentwicklung“ legt den Fokus auf den Prozess eben dieser. +- Unter dem Abschnitt „Anwenderorientiert“ werden aus Anwendersicht die Funktionen des SCM-Managers in der Basis-Variante mit dem Mindestsatz an Plugins beschrieben. Die Features der optionalen Plugins werden in separaten Dokumentationen vorgestellt. diff --git a/docs/de/user/admin/settings.md b/docs/de/user/admin/settings.md index 4105744c03..fe75784fc0 100644 --- a/docs/de/user/admin/settings.md +++ b/docs/de/user/admin/settings.md @@ -45,7 +45,7 @@ Falls die Lebensdauer verringert wird, wird jeder bisher ausgestellter JWT ungü Sollte in der `config.yml` des Servers die Option "endless JWT" aktiviert sein, dann wird diese Einstellung ignoriert. #### Anonyme Zugriff -Der SCM-Manager 2 hat das Konzept für anonyme Zugriffe über einen "_anonymous"-Benutzer realisiert. Beim Aktivieren des anonymen Zugriffs wird ein neuer Benutzer erstellt mit dem Namen "_anonymous". Dieser Nutzer kann wie ein gewöhnlicher Benutzer für unterschiedliche Aktionen berechtigt werden. Bei einem Zugriff auf den SCM-Manager ohne Zugangsdaten wird dieser anonyme Benutzer verwendet. +Der SCM-Manager hat das Konzept für anonyme Zugriffe über einen "_anonymous"-Benutzer realisiert. Beim Aktivieren des anonymen Zugriffs wird ein neuer Benutzer erstellt mit dem Namen "_anonymous". Dieser Nutzer kann wie ein gewöhnlicher Benutzer für unterschiedliche Aktionen berechtigt werden. Bei einem Zugriff auf den SCM-Manager ohne Zugangsdaten wird dieser anonyme Benutzer verwendet. Ist der anonyme Zugriff nur für Protokoll aktiviert, können die REST API und die VCS Protokolle anonym genutzt werden. Wurde der anonyme Zugriff vollständig aktiviert, ist auch ein Zugriff über den Webclient anonym möglich. Beispiel: Falls der anonyme Zugriff aktiviert ist und der "_anonymous"-Benutzer volle Zugriffsrechte auf ein bestimmtes Git-Repository hat, kann jeder über eine Kommandozeile mit den klassischen Git-Befehlen ohne Zugangsdaten auf dieses Repository zugreifen. Zugriffe über SSH werden aktuell nicht unterstützt. diff --git a/docs/en/development/build-from-source.md b/docs/en/development/build-from-source.md index 33f88886b4..67fe7ffa82 100644 --- a/docs/en/development/build-from-source.md +++ b/docs/en/development/build-from-source.md @@ -9,7 +9,7 @@ title: Building SCM-Manager from Source - Maven 3 or higher ([download](https://maven.apache.org/)) - Git ([download](https://git-scm.com/)) -### Build SCM-Manager 2.x from Source +### Build SCM-Manager from Source ```bash git clone https://github.com/scm-manager/scm-manager.git diff --git a/docs/en/development/javadoc.md b/docs/en/development/javadoc.md index 2427121594..b70fb0d308 100644 --- a/docs/en/development/javadoc.md +++ b/docs/en/development/javadoc.md @@ -3,3 +3,7 @@ title: Javadoc --- You can find the Javadoc at [javadoc](https://scm-manager.org/javadoc/). + +### Development note +Please keep in mind that any newly introduced Javadoc error causes build breaks by design. +Furthermore, it is advised to avoid warnings in case of newly introduced Javadoc comments. diff --git a/docs/en/development/ui-dod.md b/docs/en/development/ui-dod.md index 93267e92fe..e2d3049624 100644 --- a/docs/en/development/ui-dod.md +++ b/docs/en/development/ui-dod.md @@ -2,7 +2,7 @@ title: DOD for UI development --- -Use this as a kind of a checklist whenever you develop something in the UI of SCM-Manager 2.x., regardless whether you are developing core features or plugins. +Use this as a kind of checklist whenever you develop something in the UI of SCM-Manager, regardless whether you are developing core features or plugins. | | Don't forget to | |---|-----------------| diff --git a/docs/en/index.md b/docs/en/index.md index 13c4d44c5a..3f36f8c037 100644 --- a/docs/en/index.md +++ b/docs/en/index.md @@ -4,7 +4,7 @@ subtitle: SCM-Manager Documentation --- This documentation describes the administration and usage of SCM-Manager. It is available in different languages and versions, which can be selected in the menu on the right. -SCM-Manager 2 is an extremely lightweight source code management tool that can be individually extended through a variety of plugins. +SCM-Manager is an extremely lightweight source code management tool that can be individually extended through a variety of plugins. This documentation is divided into five categories: - The section "Getting started" introduces the installation and configuration of SCM-Manager and answers frequently asked questions. diff --git a/docs/en/user/admin/settings.md b/docs/en/user/admin/settings.md index cc6131e574..7207d904c1 100644 --- a/docs/en/user/admin/settings.md +++ b/docs/en/user/admin/settings.md @@ -44,7 +44,7 @@ If the amount of hours get reduced, each created JWT will be invalidated. This setting will be ignored, if the endless JWT option is set to true in the server `config.yml`. #### Anonymous Access -In SCM-Manager 2 the access for anonymous access is realized by using an "_anonymous" user. When the feature is activated, a new user with the name "_anonymous" is created. This user can be authorized just like any other user. This user is used for access to SCM-Manager without login credentials. +In SCM-Manager the access for anonymous access is realized by using an "_anonymous" user. When the feature is activated, a new user with the name "_anonymous" is created. This user can be authorized just like any other user. This user is used for access to SCM-Manager without login credentials. If the anonymous mode is protocol only you may access the SCM-Manager via the REST API and VCS protocols. With fully enabled anonymous access you can also use the webclient without credentials. Example: If anonymous access is enabled and the "_anonymous" user has full access on a certain Git repository, everybody can access this repository via command line and the classic Git commands without any login credentials. Access via SSH is not supported at this time. diff --git a/gradle/changelog/javadoc_errors.yaml b/gradle/changelog/javadoc_errors.yaml new file mode 100644 index 0000000000..9f649b69d5 --- /dev/null +++ b/gradle/changelog/javadoc_errors.yaml @@ -0,0 +1,2 @@ +- type: fixed + description: Javadoc errors diff --git a/scm-core/src/main/java/sonia/scm/api/v2/resources/ConfigurationAdapterBase.java b/scm-core/src/main/java/sonia/scm/api/v2/resources/ConfigurationAdapterBase.java index e1f698cc5c..0a8ff79188 100644 --- a/scm-core/src/main/java/sonia/scm/api/v2/resources/ConfigurationAdapterBase.java +++ b/scm-core/src/main/java/sonia/scm/api/v2/resources/ConfigurationAdapterBase.java @@ -75,21 +75,21 @@ public abstract class ConfigurationAdapterBase * The implementation may look like this: - * 
-   *   @Path("/v2/test")
-   *     private static class TestConfigurationAdapter extends ConfigurationAdapterBase {
+   * 

+   *   @Path("/v2/test")
+   *     private static class TestConfigurationAdapter extends ConfigurationAdapterBase<TestConfiguration, TestConfigurationDto> {
    *
-   *     @Inject
-   *     public TestConfigurationResource(ConfigurationStoreFactory configurationStoreFactory, Provider scmPathInfoStoreProvider) {
+   *     @Inject
+   *     public TestConfigurationResource(ConfigurationStoreFactory configurationStoreFactory, Provider<ScmPathInfoStore> scmPathInfoStoreProvider) {
    *       super(configurationStoreFactory, scmPathInfoStoreProvider, TestConfiguration.class, TestConfigurationDto.class);
    *     }
    *
-   *     @Override
+   *     @Override
    *     protected String getName() {
    *       return "testConfig";
    *     }
    *   }
-   * 

+   *
* * @param configurationStoreFactory The configuration store factory provided from injection. * @param scmPathInfoStoreProvider The path info store provider provided from injection. diff --git a/scm-core/src/main/java/sonia/scm/event/ScmEventBus.java b/scm-core/src/main/java/sonia/scm/event/ScmEventBus.java index 73b19ea1a2..46e1acc0f7 100644 --- a/scm-core/src/main/java/sonia/scm/event/ScmEventBus.java +++ b/scm-core/src/main/java/sonia/scm/event/ScmEventBus.java @@ -29,7 +29,6 @@ import java.util.ServiceLoader; * themselves. The ScmEventBus searches its implementation with the * {@link ServiceLoader}. * - * @apiviz.landmark * @see EventBus * @since 1.23 */ diff --git a/scm-core/src/main/java/sonia/scm/migration/package-info.java b/scm-core/src/main/java/sonia/scm/migration/package-info.java index 515f27734b..64a07da432 100644 --- a/scm-core/src/main/java/sonia/scm/migration/package-info.java +++ b/scm-core/src/main/java/sonia/scm/migration/package-info.java @@ -23,10 +23,9 @@ *

The data type provided by {@link sonia.scm.migration.UpdateStepTarget#getAffectedDataType()} can be an arbitrary * string, but it is considered a best practice to use a qualified name, for example *

- *

*

The version provided by {@link sonia.scm.migration.UpdateStepTarget#getTargetVersion()} is unrelated to other * versions and therefore can be chosen freely, so that a data type can be updated without in various ways independent * of other data types or the official version of the plugin or the core. @@ -69,17 +68,16 @@ * *

  • Finally, these sorted steps are executed one after another calling * {@link sonia.scm.migration.UpdateStep#doUpdate()} of each global step and - * {@link sonia.scm.migration.RepositoryUpdateStep#doUpdate(sonia.scm.migration.RepositoryUpdateContext)}
    • for each + * {@link sonia.scm.migration.RepositoryUpdateStep#doUpdate(sonia.scm.migration.RepositoryUpdateContext)} for each * repository for repository specific update steps, updating the version for the data type accordingly (if there are - * both, global and repository specific update steps for a data type and target version, the global step is called - * first), then + * both global and repository specific update steps for a data type and target version, the global step is called + * first). * *
  • If all works well, SCM-Manager then creates the runtime guice context by loading all further modules.
    • *
  • If any of the update steps fails, the whole process is interrupted and SCM-Manager will not start up and will * not record the version number of this update step. *
    • * - *

    *

    Mind that an implementation of this class has to be annotated with {@link sonia.scm.plugin.Extension}, so that the * step will be found.

    */ diff --git a/scm-core/src/main/java/sonia/scm/net/ahc/AdvancedHttpClient.java b/scm-core/src/main/java/sonia/scm/net/ahc/AdvancedHttpClient.java index eadb91440b..dc5aa5ef23 100644 --- a/scm-core/src/main/java/sonia/scm/net/ahc/AdvancedHttpClient.java +++ b/scm-core/src/main/java/sonia/scm/net/ahc/AdvancedHttpClient.java @@ -50,7 +50,6 @@ import java.io.IOException; * } * * - * @apiviz.landmark * @since 1.46 */ public abstract class AdvancedHttpClient { diff --git a/scm-core/src/main/java/sonia/scm/repository/Person.java b/scm-core/src/main/java/sonia/scm/repository/Person.java index f443435acb..b197f69f4a 100644 --- a/scm-core/src/main/java/sonia/scm/repository/Person.java +++ b/scm-core/src/main/java/sonia/scm/repository/Person.java @@ -28,7 +28,7 @@ import java.io.Serializable; /** * The {@link Person} (author) of a changeset. * - * @person Sebastian Sdorra + * @author Sebastian Sdorra */ @EqualsAndHashCode @Getter diff --git a/scm-core/src/main/java/sonia/scm/repository/RepositoryManager.java b/scm-core/src/main/java/sonia/scm/repository/RepositoryManager.java index bd07a75fe7..d99fb231bc 100644 --- a/scm-core/src/main/java/sonia/scm/repository/RepositoryManager.java +++ b/scm-core/src/main/java/sonia/scm/repository/RepositoryManager.java @@ -25,8 +25,6 @@ import java.util.function.Consumer; /** * The central class for managing {@link Repository} objects. * This class is a singleton and is available via injection. - * - * @apiviz.uses sonia.scm.repository.RepositoryHandler */ public interface RepositoryManager extends TypeManager { diff --git a/scm-core/src/main/java/sonia/scm/repository/api/BrowseCommandBuilder.java b/scm-core/src/main/java/sonia/scm/repository/api/BrowseCommandBuilder.java index 7b00600bf2..c36a4d8454 100644 --- a/scm-core/src/main/java/sonia/scm/repository/api/BrowseCommandBuilder.java +++ b/scm-core/src/main/java/sonia/scm/repository/api/BrowseCommandBuilder.java @@ -50,7 +50,7 @@ import java.util.function.Supplier; * for ( FileObject fo : result ){ * System.out.println( fo.getPath() ); * } - * + * * * @since 1.17 */ diff --git a/scm-core/src/main/java/sonia/scm/repository/api/ModifyCommandBuilder.java b/scm-core/src/main/java/sonia/scm/repository/api/ModifyCommandBuilder.java index 93d3d27166..64eb929209 100644 --- a/scm-core/src/main/java/sonia/scm/repository/api/ModifyCommandBuilder.java +++ b/scm-core/src/main/java/sonia/scm/repository/api/ModifyCommandBuilder.java @@ -59,7 +59,6 @@ import java.util.function.Consumer; * .deleteFile("old/file/to/delete") * .execute(); * - *

    */ public class ModifyCommandBuilder { diff --git a/scm-core/src/main/java/sonia/scm/repository/api/RepositoryServiceFactory.java b/scm-core/src/main/java/sonia/scm/repository/api/RepositoryServiceFactory.java index 3196fee202..87e5d9a639 100644 --- a/scm-core/src/main/java/sonia/scm/repository/api/RepositoryServiceFactory.java +++ b/scm-core/src/main/java/sonia/scm/repository/api/RepositoryServiceFactory.java @@ -93,8 +93,6 @@ import static sonia.scm.NotFoundException.notFound; * } * * - * @apiviz.landmark - * @apiviz.uses sonia.scm.repository.api.RepositoryService * @since 1.17 */ @Singleton diff --git a/scm-core/src/main/java/sonia/scm/repository/api/UnbundleCommandBuilder.java b/scm-core/src/main/java/sonia/scm/repository/api/UnbundleCommandBuilder.java index aa0a71f963..2143cd47fb 100644 --- a/scm-core/src/main/java/sonia/scm/repository/api/UnbundleCommandBuilder.java +++ b/scm-core/src/main/java/sonia/scm/repository/api/UnbundleCommandBuilder.java @@ -39,7 +39,7 @@ import static com.google.common.base.Preconditions.checkNotNull; * The unbundle command can restore an empty repository from a bundle. The * bundle can be created with the {@link BundleCommandBuilder}. * - * @author Sebastian Sdorra + * @author Sebastian Sdorra * @since 1.43 */ public final class UnbundleCommandBuilder diff --git a/scm-core/src/main/java/sonia/scm/repository/spi/BundleCommandRequest.java b/scm-core/src/main/java/sonia/scm/repository/spi/BundleCommandRequest.java index 0615e1646d..31d9e2e025 100644 --- a/scm-core/src/main/java/sonia/scm/repository/spi/BundleCommandRequest.java +++ b/scm-core/src/main/java/sonia/scm/repository/spi/BundleCommandRequest.java @@ -23,7 +23,7 @@ import com.google.common.io.ByteSink; /** * Request for the bundle command. * - * @author Sebastian Sdorra + * @author Sebastian Sdorra * @since 1.43 */ public final class BundleCommandRequest diff --git a/scm-core/src/main/java/sonia/scm/repository/spi/UnbundleCommand.java b/scm-core/src/main/java/sonia/scm/repository/spi/UnbundleCommand.java index bdbf7b29d4..acc5aa93a5 100644 --- a/scm-core/src/main/java/sonia/scm/repository/spi/UnbundleCommand.java +++ b/scm-core/src/main/java/sonia/scm/repository/spi/UnbundleCommand.java @@ -24,7 +24,7 @@ import java.io.IOException; /** * Service provider implementation for the unbundle command. * - * @author Sebastian Sdorra + * @author Sebastian Sdorra * @since 1.43 */ public interface UnbundleCommand diff --git a/scm-core/src/main/java/sonia/scm/repository/spi/UnbundleCommandRequest.java b/scm-core/src/main/java/sonia/scm/repository/spi/UnbundleCommandRequest.java index 2d279dcda6..e7edcd1097 100644 --- a/scm-core/src/main/java/sonia/scm/repository/spi/UnbundleCommandRequest.java +++ b/scm-core/src/main/java/sonia/scm/repository/spi/UnbundleCommandRequest.java @@ -28,7 +28,7 @@ import java.util.function.Consumer; /** * Request object for the unbundle command. * - * @author Sebastian Sdorra + * @author Sebastian Sdorra * @since 1.43 */ public final class UnbundleCommandRequest { diff --git a/scm-core/src/main/java/sonia/scm/repository/work/SimpleCachingWorkingCopyPool.java b/scm-core/src/main/java/sonia/scm/repository/work/SimpleCachingWorkingCopyPool.java index 35e9b22fe0..61403dca5c 100644 --- a/scm-core/src/main/java/sonia/scm/repository/work/SimpleCachingWorkingCopyPool.java +++ b/scm-core/src/main/java/sonia/scm/repository/work/SimpleCachingWorkingCopyPool.java @@ -52,8 +52,6 @@ import static java.util.Optional.of; * If for one repository a working copy is requested, while another is in use already, * the process will wait until the other process has finished. * The number of directories cached is limited. By default, directories are cached for - * {@value DEFAULT_WORKING_COPY_POOL_SIZE} repositories. This can be changes with the system - * property '{@value WORKING_COPY_POOL_SIZE_PROPERTY}' (if this is set to zero, no caching will * take place; to cache the directories for each repository without eviction simply set this to a * high enough value). *
    diff --git a/scm-core/src/main/java/sonia/scm/repository/work/SimpleWorkingCopyFactory.java b/scm-core/src/main/java/sonia/scm/repository/work/SimpleWorkingCopyFactory.java index 1c6e427d2d..57188dcc73 100644 --- a/scm-core/src/main/java/sonia/scm/repository/work/SimpleWorkingCopyFactory.java +++ b/scm-core/src/main/java/sonia/scm/repository/work/SimpleWorkingCopyFactory.java @@ -54,7 +54,8 @@ import java.io.File; *
    * The general process looks like this: *
    - * + * Shows a sequence diagram illustrating the interaction between components in a system related to a working copy process. + * * @param Type of central repository location * @param Type of working copy for repository * @param Type of repository context @@ -113,7 +114,7 @@ public abstract class SimpleWorkingCopyFactory { diff --git a/scm-core/src/main/java/sonia/scm/store/BlobStoreFactory.java b/scm-core/src/main/java/sonia/scm/store/BlobStoreFactory.java index 7a6531a8fb..c932393b11 100644 --- a/scm-core/src/main/java/sonia/scm/store/BlobStoreFactory.java +++ b/scm-core/src/main/java/sonia/scm/store/BlobStoreFactory.java @@ -18,26 +18,23 @@ package sonia.scm.store; /** * The BlobStoreFactory can be used to create a new or get an existing {@link BlobStore}s. - *
    - * You can either create a global {@link BlobStore} or a {@link BlobStore} for a specific repository. To create a global - * {@link BlobStore} call: - * 
    - *     blobStoreFactory
- *       .withName("name")
- *       .build();
- *
    - * To create a {@link BlobStore} for a specific repository call: - * 
    - *     blobStoreFactory
- *       .withName("name")
- *       .forRepository(repository)
- *       .build();
- *
    + * You can either create a global {@link BlobStore} or a {@link BlobStore} for a specific repository. + *
    + *
    + * Call this to create a global {@link BlobStore}: + *
    + * + * blobStoreFactory.withName("name").build(); + * + *
    + *
    + * Call this to create a {@link BlobStore} for a specific repository: + *
    + * + * blobStoreFactory.withName("name").forRepository(repository).build(); + * * * @since 1.23 - * - * @apiviz.landmark - * @apiviz.uses sonia.scm.store.BlobStore */ public interface BlobStoreFactory { diff --git a/scm-core/src/main/java/sonia/scm/store/ConfigurationEntryStoreFactory.java b/scm-core/src/main/java/sonia/scm/store/ConfigurationEntryStoreFactory.java index d29bcd078d..8cb01a7423 100644 --- a/scm-core/src/main/java/sonia/scm/store/ConfigurationEntryStoreFactory.java +++ b/scm-core/src/main/java/sonia/scm/store/ConfigurationEntryStoreFactory.java @@ -17,32 +17,30 @@ package sonia.scm.store; /** - * The ConfigurationEntryStoreFactory can be used to create new or get existing {@link ConfigurationEntryStore}s. - *
    * Note: the default implementation uses the same location as the {@link ConfigurationStoreFactory}, so be sure * that the store names are unique for all {@link ConfigurationEntryStore}s and {@link ConfigurationEntryStore}s. - *
    + *
    + *
    + * The ConfigurationEntryStoreFactory can be used to create new or get existing {@link ConfigurationEntryStore}s. + *
    + *
    * You can either create a global {@link ConfigurationEntryStore} or a {@link ConfigurationEntryStore} for a specific - * repository. To create a global {@link ConfigurationEntryStore} call: - * 
    - *     configurationEntryStoreFactory
- *       .withType(PersistedType.class)
- *       .withName("name")
- *       .build();
- *
    - * To create a {@link ConfigurationEntryStore} for a specific repository call: - * 
    + * repository. Call this to create a global {@link ConfigurationEntryStore}:
+ * 
    
+ * configurationEntryStoreFactory.withType(PersistedType.class).withName("name").build();
+ * 
    
+ * 
    
+ * Call this to create a {@link ConfigurationEntryStore} for a specific repository:
+ * 
    
+ * 
  *     configurationEntryStoreFactory
  *       .withType(PersistedType.class)
  *       .withName("name")
  *       .forRepository(repository)
  *       .build();
- *
    + *     * * @since 1.31 - * - * @apiviz.landmark - * @apiviz.uses sonia.scm.store.ConfigurationEntryStore */ public interface ConfigurationEntryStoreFactory { diff --git a/scm-core/src/main/java/sonia/scm/store/ConfigurationStoreFactory.java b/scm-core/src/main/java/sonia/scm/store/ConfigurationStoreFactory.java index 1b8d287996..4b53e991ad 100644 --- a/scm-core/src/main/java/sonia/scm/store/ConfigurationStoreFactory.java +++ b/scm-core/src/main/java/sonia/scm/store/ConfigurationStoreFactory.java @@ -18,31 +18,21 @@ package sonia.scm.store; /** - * The ConfigurationStoreFactory can be used to create new or get existing {@link ConfigurationStore} objects. - *
    * Note: the default implementation uses the same location as the {@link ConfigurationEntryStoreFactory}, so be * sure that the store names are unique for all {@link ConfigurationEntryStore}s and {@link ConfigurationStore}s. - *
    + *
    + *
    + * The ConfigurationStoreFactory can be used to create new or get existing {@link ConfigurationStore} objects. * You can either create a global {@link ConfigurationStore} or a {@link ConfigurationStore} for a specific repository. - * To create a global {@link ConfigurationStore} call: - * 
    - *     configurationStoreFactory
- *       .withType(PersistedType.class)
- *       .withName("name")
- *       .build();
- *
    - * To create a {@link ConfigurationStore} for a specific repository call: - * 
    - *     configurationStoreFactory
- *       .withType(PersistedType.class)
- *       .withName("name")
- *       .forRepository(repository)
- *       .build();
- *
    - * - * - * @apiviz.landmark - * @apiviz.uses sonia.scm.store.ConfigurationStore + *
    + *
    + * Call this to create a global {@link ConfigurationStore}: + * configurationStoreFactory.withType(PersistedType.class).withName("name").build(); + *
    + *
    + * Call this to create a {@link ConfigurationStore} for a specific repository: + *
    + * configurationStoreFactory.withType(PersistedType.class).withName("name").forRepository(repository).build(); */ public interface ConfigurationStoreFactory { diff --git a/scm-core/src/main/java/sonia/scm/store/DataStoreFactory.java b/scm-core/src/main/java/sonia/scm/store/DataStoreFactory.java index ad541247a1..a78e8dd6ec 100644 --- a/scm-core/src/main/java/sonia/scm/store/DataStoreFactory.java +++ b/scm-core/src/main/java/sonia/scm/store/DataStoreFactory.java @@ -18,28 +18,19 @@ package sonia.scm.store; /** * The DataStoreFactory can be used to create new or get existing {@link DataStore}s. - *
    * You can either create a global {@link DataStore} or a {@link DataStore} for a specific repository. - * To create a global {@link DataStore} call: - * 
    - *     dataStoreFactory
- *       .withType(PersistedType.class)
- *       .withName("name")
- *       .build();
- *
    - * To create a {@link DataStore} for a specific repository call: - * 
    - *     dataStoreFactory
- *       .withType(PersistedType.class)
- *       .withName("name")
- *       .forRepository(repository)
- *       .build();
- *
    + *
    + *
    + * Call this to create a global {@link DataStore}: + *
    + * dataStoreFactory.withType(PersistedType.class).withName("name").build(); + *
    + *
    + * To create a {@link DataStore} for a specific repository: + *
    + * dataStoreFactory.withType(PersistedType.class).withName("name").forRepository(repository).build(); * * @since 1.23 - * - * @apiviz.landmark - * @apiviz.uses sonia.scm.store.DataStore */ public interface DataStoreFactory { diff --git a/scm-core/src/main/java/sonia/scm/template/TemplateEngine.java b/scm-core/src/main/java/sonia/scm/template/TemplateEngine.java index 8c929f8f0f..2416caf944 100644 --- a/scm-core/src/main/java/sonia/scm/template/TemplateEngine.java +++ b/scm-core/src/main/java/sonia/scm/template/TemplateEngine.java @@ -25,8 +25,6 @@ import java.util.Locale; * template for the rendering process. * * @since 1.19 - * - * @apiviz.uses sonia.scm.template.Template */ public interface TemplateEngine { diff --git a/scm-core/src/main/java/sonia/scm/template/TemplateEngineFactory.java b/scm-core/src/main/java/sonia/scm/template/TemplateEngineFactory.java index 5a79444f66..5ebe9a0cfc 100644 --- a/scm-core/src/main/java/sonia/scm/template/TemplateEngineFactory.java +++ b/scm-core/src/main/java/sonia/scm/template/TemplateEngineFactory.java @@ -36,9 +36,6 @@ import java.util.Set; * {@link TemplateEngineFactory} is available via injection. * * @since 1.19 - * - * @apiviz.landmark - * @apiviz.uses sonia.scm.template.TemplateEngine */ @Singleton public final class TemplateEngineFactory diff --git a/scm-core/src/test/java/sonia/scm/web/UserAgentParserTest.java b/scm-core/src/test/java/sonia/scm/web/UserAgentParserTest.java index b6ecb4c234..ccc24b5b40 100644 --- a/scm-core/src/test/java/sonia/scm/web/UserAgentParserTest.java +++ b/scm-core/src/test/java/sonia/scm/web/UserAgentParserTest.java @@ -37,7 +37,7 @@ import static org.mockito.Mockito.when; /** * - * @author Sebastian Sdorra + * @author Sebastian Sdorra */ @SuppressWarnings("unchecked") @RunWith(MockitoJUnitRunner.class) diff --git a/scm-plugins/scm-git-plugin/src/test/java/sonia/scm/repository/GitGcTaskTest.java b/scm-plugins/scm-git-plugin/src/test/java/sonia/scm/repository/GitGcTaskTest.java index 7309a54eb7..924a45a8a7 100644 --- a/scm-plugins/scm-git-plugin/src/test/java/sonia/scm/repository/GitGcTaskTest.java +++ b/scm-plugins/scm-git-plugin/src/test/java/sonia/scm/repository/GitGcTaskTest.java @@ -38,7 +38,7 @@ import static org.mockito.Mockito.when; /** * Unit tests for {@link GitGcTask}. * - * @author Sebastian Sdorra + * @author Sebastian Sdorra */ @RunWith(MockitoJUnitRunner.class) public class GitGcTaskTest diff --git a/scm-plugins/scm-git-plugin/src/test/java/sonia/scm/web/GitUserAgentProviderTest.java b/scm-plugins/scm-git-plugin/src/test/java/sonia/scm/web/GitUserAgentProviderTest.java index cd33a4322f..d0601cacc6 100644 --- a/scm-plugins/scm-git-plugin/src/test/java/sonia/scm/web/GitUserAgentProviderTest.java +++ b/scm-plugins/scm-git-plugin/src/test/java/sonia/scm/web/GitUserAgentProviderTest.java @@ -24,7 +24,7 @@ import static org.junit.Assert.*; /** * Unit tests for {@link GitUserAgentProvider}. * - * @author Sebastian Sdorra + * @author Sebastian Sdorra */ public class GitUserAgentProviderTest { diff --git a/scm-plugins/scm-hg-plugin/src/test/java/sonia/scm/web/HgUserAgentProviderTest.java b/scm-plugins/scm-hg-plugin/src/test/java/sonia/scm/web/HgUserAgentProviderTest.java index fb2e501914..167043eb11 100644 --- a/scm-plugins/scm-hg-plugin/src/test/java/sonia/scm/web/HgUserAgentProviderTest.java +++ b/scm-plugins/scm-hg-plugin/src/test/java/sonia/scm/web/HgUserAgentProviderTest.java @@ -27,7 +27,7 @@ import java.util.Locale; /** * - * @author Sebastian Sdorra + * @author Sebastian Sdorra */ public class HgUserAgentProviderTest { diff --git a/scm-plugins/scm-svn-plugin/src/test/java/sonia/scm/web/SvnUserAgentProviderTest.java b/scm-plugins/scm-svn-plugin/src/test/java/sonia/scm/web/SvnUserAgentProviderTest.java index 0cdbaf3951..3d9ee79cf3 100644 --- a/scm-plugins/scm-svn-plugin/src/test/java/sonia/scm/web/SvnUserAgentProviderTest.java +++ b/scm-plugins/scm-svn-plugin/src/test/java/sonia/scm/web/SvnUserAgentProviderTest.java @@ -26,7 +26,7 @@ import java.util.Locale; /** * - * @author Sebastian Sdorra + * @author Sebastian Sdorra */ public class SvnUserAgentProviderTest { diff --git a/scm-webapp/src/main/java/sonia/scm/api/v2/resources/IncomingRootResource.java b/scm-webapp/src/main/java/sonia/scm/api/v2/resources/IncomingRootResource.java index 9726cd87de..9dd0b94687 100644 --- a/scm-webapp/src/main/java/sonia/scm/api/v2/resources/IncomingRootResource.java +++ b/scm-webapp/src/main/java/sonia/scm/api/v2/resources/IncomingRootResource.java @@ -98,7 +98,6 @@ public class IncomingRootResource { * @param page * @param pageSize * @return - * @throws Exception */ @GET @Path("{source}/{target}/changesets") diff --git a/scm-webapp/src/main/java/sonia/scm/lifecycle/modules/resteasyguice/RequestScopeModule.java b/scm-webapp/src/main/java/sonia/scm/lifecycle/modules/resteasyguice/RequestScopeModule.java index b3e7c5f5c9..fd939c397d 100644 --- a/scm-webapp/src/main/java/sonia/scm/lifecycle/modules/resteasyguice/RequestScopeModule.java +++ b/scm-webapp/src/main/java/sonia/scm/lifecycle/modules/resteasyguice/RequestScopeModule.java @@ -33,7 +33,7 @@ import org.jboss.resteasy.core.ResteasyContext; /** * Binds the {@link RequestScoped} to the current HTTP request and - * makes all the classes available via the {@link javax.ws.rs.core.Context} annotation injectable. + * makes all the classes available via the {@link jakarta.ws.rs.core.Context} annotation injectable. */ public class RequestScopeModule extends AbstractModule { diff --git a/scm-webapp/src/main/java/sonia/scm/update/repository/XmlRepositoryV1UpdateStep.java b/scm-webapp/src/main/java/sonia/scm/update/repository/XmlRepositoryV1UpdateStep.java index 390b432751..5cafb26094 100644 --- a/scm-webapp/src/main/java/sonia/scm/update/repository/XmlRepositoryV1UpdateStep.java +++ b/scm-webapp/src/main/java/sonia/scm/update/repository/XmlRepositoryV1UpdateStep.java @@ -57,8 +57,7 @@ import static sonia.scm.version.Version.parse; *
  • a new entry in the new repository-paths.xml database is written,
    • *
  • the data directory is moved or copied to a SCM v2 consistent directory. How this is done * can be specified by a strategy (@see {@link MigrationStrategy}), that has to be set in - * a database file named migration-plan.xml
    • (to create this file, use {@link DefaultMigrationStrategyDAO}), - * and + * a database file named migration-plan.xml (to create this file, use {@link DefaultMigrationStrategyDAO}), and *
  • the new metadata.xml file is created.
    • * * diff --git a/scm-webapp/src/test/java/sonia/scm/filter/MDCFilterTest.java b/scm-webapp/src/test/java/sonia/scm/filter/MDCFilterTest.java index b1e1ce71fb..935320a791 100644 --- a/scm-webapp/src/test/java/sonia/scm/filter/MDCFilterTest.java +++ b/scm-webapp/src/test/java/sonia/scm/filter/MDCFilterTest.java @@ -44,7 +44,7 @@ import static org.mockito.Mockito.when; /** * Unit tests for {@link MDCFilter}. * - * @author Sebastian Sdorra + * @author Sebastian Sdorra */ @RunWith(MockitoJUnitRunner.Silent.class) public class MDCFilterTest extends AbstractTestBase { diff --git a/scm-webapp/src/test/java/sonia/scm/web/BrowserUserAgentProviderTest.java b/scm-webapp/src/test/java/sonia/scm/web/BrowserUserAgentProviderTest.java index da78ffb380..ed5aef0e64 100644 --- a/scm-webapp/src/test/java/sonia/scm/web/BrowserUserAgentProviderTest.java +++ b/scm-webapp/src/test/java/sonia/scm/web/BrowserUserAgentProviderTest.java @@ -29,7 +29,7 @@ import java.util.Locale; /** * - * @author Sebastian Sdorra + * @author Sebastian Sdorra */ public class BrowserUserAgentProviderTest {