diff --git a/dspace/modules/additions/src/main/java/org/dspace/example/Example.java b/dspace/modules/additions/src/main/java/org/dspace/example/Example.java index f77ea88031..09dbd71f39 100644 --- a/dspace/modules/additions/src/main/java/org/dspace/example/Example.java +++ b/dspace/modules/additions/src/main/java/org/dspace/example/Example.java @@ -8,9 +8,7 @@ package org.dspace.example; /** - * TODO: Add Description - * - * @author mdiggory @ atmire.com + * This interface serves as an example of how & where to add local customizations to the DSpace REST API. */ public interface Example { } diff --git a/dspace/modules/additions/src/main/java/org/dspace/example/impl/ExampleImpl.java b/dspace/modules/additions/src/main/java/org/dspace/example/impl/ExampleImpl.java index 95e897eece..195720d807 100644 --- a/dspace/modules/additions/src/main/java/org/dspace/example/impl/ExampleImpl.java +++ b/dspace/modules/additions/src/main/java/org/dspace/example/impl/ExampleImpl.java @@ -10,9 +10,7 @@ package org.dspace.example.impl; import org.dspace.example.Example; /** - * TODO: Add Description - * - * @author mdiggory @ atmire.com + * This class serves as an example of how & where to add local customizations to the DSpace REST API. */ public class ExampleImpl implements Example { } diff --git a/dspace/modules/additions/src/test/java/org/dspace/example/ExampleIT.java b/dspace/modules/additions/src/test/java/org/dspace/example/ExampleIT.java index 01594583fb..8349f72eb6 100644 --- a/dspace/modules/additions/src/test/java/org/dspace/example/ExampleIT.java +++ b/dspace/modules/additions/src/test/java/org/dspace/example/ExampleIT.java @@ -14,6 +14,10 @@ import org.dspace.example.impl.ExampleImpl; import org.dspace.utils.DSpace; import org.junit.Test; +/** + * This IT serves as an an example of how & where to add integration tests for local customizations to the DSpace API. + * See {@link Example} and {@link ExampleImpl} for the class of which the functionality is tested. + */ public class ExampleIT extends AbstractIntegrationTest { @Test diff --git a/dspace/modules/server/src/test/java/org/dspace/app/rest/example/ExampleController.java b/dspace/modules/server/src/test/java/org/dspace/app/rest/example/ExampleController.java index 0f4467b799..c4abd4dcea 100644 --- a/dspace/modules/server/src/test/java/org/dspace/app/rest/example/ExampleController.java +++ b/dspace/modules/server/src/test/java/org/dspace/app/rest/example/ExampleController.java @@ -10,6 +10,10 @@ package org.dspace.app.rest.example; import org.springframework.web.bind.annotation.RequestMapping; import org.springframework.web.bind.annotation.RestController; +/** + * This Controller serves as an example of how & where to add local customizations to the DSpace REST API. + * See {@link ExampleControllerIT} for the integration tests for this controller. + */ @RestController @RequestMapping("example") public class ExampleController { diff --git a/dspace/modules/server/src/test/java/org/dspace/app/rest/example/ExampleControllerIT.java b/dspace/modules/server/src/test/java/org/dspace/app/rest/example/ExampleControllerIT.java index 03ee6d0d0c..d9626f6b78 100644 --- a/dspace/modules/server/src/test/java/org/dspace/app/rest/example/ExampleControllerIT.java +++ b/dspace/modules/server/src/test/java/org/dspace/app/rest/example/ExampleControllerIT.java @@ -14,6 +14,10 @@ import static org.springframework.test.web.servlet.result.MockMvcResultMatchers. import org.dspace.app.rest.test.AbstractControllerIntegrationTest; import org.junit.Test; +/** + * This IT serves as an example of how & where to add integration tests for local customizations to the DSpace REST API. + * See {@link ExampleController} for the Controller of which the functionality is tested. + */ public class ExampleControllerIT extends AbstractControllerIntegrationTest { @Test