You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@isis.apache.org by da...@apache.org on 2021/02/05 07:00:48 UTC
[isis] 02/02: ISIS-2444: further doc improvements
This is an automated email from the ASF dual-hosted git repository.
danhaywood pushed a commit to branch ISIS-2444
in repository https://gitbox.apache.org/repos/asf/isis.git
commit ca2980abefd44ac122fa5cf53ba442c762ac6a19
Author: danhaywood <da...@haywood-associates.co.uk>
AuthorDate: Fri Feb 5 06:52:29 2021 +0000
ISIS-2444: further doc improvements
---
.../modules/applib-svc/pages/ClockService.adoc | 6 +--
.../pages/CommandDtoProcessorService.adoc | 48 +---------------------
2 files changed, 4 insertions(+), 50 deletions(-)
diff --git a/api/applib/src/main/adoc/modules/applib-svc/pages/ClockService.adoc b/api/applib/src/main/adoc/modules/applib-svc/pages/ClockService.adoc
index 283eb78..8b0e273 100644
--- a/api/applib/src/main/adoc/modules/applib-svc/pages/ClockService.adoc
+++ b/api/applib/src/main/adoc/modules/applib-svc/pages/ClockService.adoc
@@ -24,11 +24,9 @@ Apache Isis provides such a facade through the `ClockService`.
include::system:generated:page$index/applib/services/clock/ClockService.adoc[leveloffset=+2]
-Note that this domain service is also used by the framework itself to obtain the time, so it acts as an SPI as well.
+include::system:generated:page$index/applib/clock/VirtualClock.adoc[leveloffset=+2]
+Note that this domain service is also used by the framework itself to obtain the time, so it acts as an SPI as well.
-== Implementation
-This class (`o.a.i.applib.services.clock.ClockService`) is also the default implementation.
-The time provided by this default implementation is based on the system clock.
diff --git a/api/applib/src/main/adoc/modules/applib-svc/pages/CommandDtoProcessorService.adoc b/api/applib/src/main/adoc/modules/applib-svc/pages/CommandDtoProcessorService.adoc
index 178495a..21e03da 100644
--- a/api/applib/src/main/adoc/modules/applib-svc/pages/CommandDtoProcessorService.adoc
+++ b/api/applib/src/main/adoc/modules/applib-svc/pages/CommandDtoProcessorService.adoc
@@ -18,57 +18,13 @@ Another use case is to strip out large blobs for performance reasons.
include::system:generated:page$index/applib/services/commanddto/processor/spi/CommandDtoProcessorService.adoc[leveloffset=+2]
-TODO example migration
-
-.Deprecated Docs
-[WARNING]
-================================
-
-== API
-
-The API defined by `CommandDtoProcessorService` is:
-
-[source,java]
-----
-include::refguide:applib-svc:example$services/commanddto/processor/spi/CommandDtoProcessorService.java[tags="refguide"]
-----
-
-
-
-================================
-
-== Implementation
-
-As noted in the introduction, the framework provides a default implementation, namely `o.a.i.applib.services.commanddto.conmap.ContentMappingServiceForCommandDto`.
-
-
-== API
-
-include::system:generated:page$index/applib/services/commanddto/processor/CommandDtoProcessor.adoc[leveloffset=+2]
-
-TODO example migration
-
-.Deprecated Docs
-[WARNING]
-================================
-
-== Related Classes
The `CommandDtoProcessorService` is a global fallback for serializing actions of commands into a DTO.
-However, this can be overridden on on an action-by-action basis using xref:refguide:applib-ant:Action.adoc#commanddtoprocessor[`@Action#commandDtoProcessor`], and on a property-by-property basis using xref:refguide:applib-ant:Property.adoc#commanddtoprocessor[`@Command#commandDtoProcessor()`].
+However, this can be overridden on on an action-by-action basis using xref:refguide:applib-ant:Action.adoc[`@Action#commandDtoProcessor`], and on a property-by-property basis using xref:refguide:applib-ant:Property.adoc[`@Command#commandDtoProcessor()`].
The main use case is to allow certain actions/property edits to be ignored:
-[source,java]
-----
-include::refguide:applib-svc:example$services/commanddto/processor/CommandDtoProcessor.java[tags="refguide"]
-----
-<.> Returning `null` means that the command's DTO is effectively ignored.
+include::system:generated:page$index/applib/services/commanddto/processor/CommandDtoProcessor.adoc[leveloffset=+2]
-================================
-
-== Related Services
-* the `CommandDtoProcessorService` is used by xref:refguide:applib-svc:ContentMappingService.adoc[`ContentMappingService`] to serialize ``Command``s over the REST API provided by xref:vro:ROOT:about.adoc[Restful Objects viewer].
-All implementations are used.