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 2019/01/11 12:25:21 UTC
[isis] 05/05: ISIS-2072: cleans up some annotation docs
This is an automated email from the ASF dual-hosted git repository.
danhaywood pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/isis.git
commit ea0e3be95d431a2a1502bbadca909387609b6a0c
Author: danhaywood <da...@haywood-associates.co.uk>
AuthorDate: Fri Jan 11 12:19:23 2019 +0000
ISIS-2072: cleans up some annotation docs
"See also" section made consistent.
---
.../guides/rgant/_rgant-ActionLayout_bookmarking.adoc | 10 ++++++++--
.../asciidoc/guides/rgant/_rgant-ActionLayout_named.adoc | 1 +
.../asciidoc/guides/rgant/_rgant-Action_domainEvent.adoc | 9 +++++++--
.../asciidoc/guides/rgant/_rgant-Action_publishing.adoc | 13 ++++++++++++-
.../guides/rgant/_rgant-CollectionLayout_cssClass.adoc | 8 +++++++-
.../guides/rgant/_rgant-CollectionLayout_named.adoc | 1 +
.../guides/rgant/_rgant-Collection_domainEvent.adoc | 10 +++++++---
.../guides/rgant/_rgant-Collection_notPersisted.adoc | 8 +++++++-
.../guides/rgant/_rgant-DomainObject_publishing.adoc | 15 ++++++++++++++-
.../guides/rgant/_rgant-DomainServiceLayout_named.adoc | 3 ++-
.../asciidoc/guides/rgant/_rgant-ParameterLayout.adoc | 6 ++++--
.../rgant/_rgant-ParameterLayout_renderedAsDayBefore.adoc | 11 +++++++++--
.../rgant/_rgant-ParameterLayout_typicalLength.adoc | 7 +++++--
.../rgant/_rgant-PropertyLayout_renderedAsDayBefore.adoc | 13 +++++++++++--
.../guides/rgant/_rgant-PropertyLayout_typicalLength.adoc | 7 +++++--
.../guides/rgant/_rgant-Property_domainEvent.adoc | 9 ++++++++-
.../guides/rgant/_rgant-Property_notPersisted.adoc | 6 +++++-
.../asciidoc/guides/rgant/_rgant-Property_publishing.adoc | 13 ++++++++++++-
18 files changed, 125 insertions(+), 25 deletions(-)
diff --git a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-ActionLayout_bookmarking.adoc b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-ActionLayout_bookmarking.adoc
index c266d06..a9e2832 100644
--- a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-ActionLayout_bookmarking.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-ActionLayout_bookmarking.adoc
@@ -6,7 +6,8 @@
-The `bookmarking()` attribute indicates if an action (with safe xref:../rgant/rgant.adoc#_rgant-Action_semantics[action semantics]) is automatically bookmarked. This attribute is also supported for xref:../rgant/rgant.adoc#_rgant-DomainObjectLayout_bookmarking[domain objects].
+The `bookmarking()` attribute indicates if an action (with safe xref:../rgant/rgant.adoc#_rgant-Action_semantics[action semantics]) is automatically bookmarked.
+
@@ -51,4 +52,9 @@ The enum value `AS_CHILD` has no meaning for actions; it relates only to bookmar
== Alternatives
-As an alternative to using the annotation, the dynamic xref:../ugvw/ugvw.adoc#_ugvw_layout_file-based[file-based layout] can be used instead.
\ No newline at end of file
+As an alternative to using the annotation, the dynamic xref:../ugvw/ugvw.adoc#_ugvw_layout_file-based[file-based layout] can be used instead.
+
+
+== See also
+
+This attribute is also supported for xref:../rgant/rgant.adoc#_rgant-DomainObjectLayout_bookmarking[domain objects].
\ No newline at end of file
diff --git a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-ActionLayout_named.adoc b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-ActionLayout_named.adoc
index 0abd89e..9f62bba 100644
--- a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-ActionLayout_named.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-ActionLayout_named.adoc
@@ -39,6 +39,7 @@ The framework also provides a separate, powerful mechanism for xref:../ugbtb/ugb
== See also
This attribute can also be specified for:
+
* xref:../rgant/rgant.adoc#_rgant-CollectionLayout_named[collections]
* xref:../rgant/rgant.adoc#_rgant-PropertyLayout_named[properties]
* xref:../rgant/rgant.adoc#_rgant-ParameterLayout_named[parameters]
diff --git a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-Action_domainEvent.adoc b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-Action_domainEvent.adoc
index ed63229..bec30d1 100644
--- a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-Action_domainEvent.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-Action_domainEvent.adoc
@@ -31,8 +31,7 @@ public class ToDoItem {
The `domainEvent()` attribute allows a custom subclass to be emitted allowing more precise subscriptions (to those
subclasses) to be defined instead.
-This attribute is also supported for
-xref:../rgant/rgant.adoc#_rgant-Collection_domainEvent[collections] and xref:../rgant/rgant.adoc#_rgant-Property_domainEvent[properties].
+
For example:
@@ -174,6 +173,12 @@ Normally events are only raised for interactions through the UI.
However, events can be raised programmatically either by calling the xref:../rgsvc/rgsvc.adoc#_rgsvc_core-domain-api_EventBusService[`EventBusService`] API directly, or by emulating the UI by wrapping the target object using the xref:../rgsvc/rgsvc.adoc#_rgsvc_application-layer-api_WrapperFactory[`WrapperFactory`] domain service.
+== See also
+
+This attribute is also supported for:
+
+* xref:../rgant/rgant.adoc#_rgant-Collection_domainEvent[collections] and
+* xref:../rgant/rgant.adoc#_rgant-Property_domainEvent[properties].
diff --git a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-Action_publishing.adoc b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-Action_publishing.adoc
index 6cd224c..92dbcc2 100644
--- a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-Action_publishing.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-Action_publishing.adoc
@@ -8,7 +8,6 @@
The `publishing()` attribute determines whether and how an action invocation is published via the registered implementation of a xref:../rgsvc/rgsvc.adoc#_rgsvc_persistence-layer-spi_PublishingService[`PublishingService`]) or xref:../rgsvc/rgsvc.adoc#_rgsvc_persistence-layer-spi_PublisherService[`PublisherService`].
-This attribute is also supported for xref:../rgant/rgant.adoc#_rgant-DomainObject_publishing[domain objects], where it controls whether changed objects are published as events, and for xref:../rgant/rgant.adoc#_rgant-Property_publishing[`@Property#publishing()`], where it controls whether property edits are published as events.
A common use case is to notify external "downstream" systems of changes in the state of the Apache Isis application.
The default value for the attribute is `AS_CONFIGURED`, meaning that the xref:../rgcfg/rgcfg.adoc#_rgcfg_configuring-core[configuration property] `isis.services.publish.actions` is used to determine the whether the action is published:
@@ -59,3 +58,15 @@ It is ignored by the replacement xref:../rgsvc/rgsvc.adoc#_rgsvc_persistence-lay
+== See also
+
+This attribute is also supported for:
+
+* xref:../rgant/rgant.adoc#_rgant-DomainObject_publishing[domain objects]
++ where it controls whether changed objects are published as events, and for
+
+* xref:../rgant/rgant.adoc#_rgant-Property_publishing[properties]
++
+where it controls whether property edits are published as events.
+
+
diff --git a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-CollectionLayout_cssClass.adoc b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-CollectionLayout_cssClass.adoc
index 551723b..b92a5e1 100644
--- a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-CollectionLayout_cssClass.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-CollectionLayout_cssClass.adoc
@@ -32,4 +32,10 @@ As an alternative to using the annotation, the dynamic xref:../ugvw/ugvw.adoc#_u
== See also
-This attribute can also be applied to xref:../rgant/rgant.adoc#_rgant-DomainObjectLayout_cssClass[domain objects], xref:../rgant/rgant.adoc#_rgant-ViewModelLayout_cssClass[view models], xref:../rgant/rgant.adoc#_rgant-ActionLayout_cssClass[actions], xref:../rgant/rgant.adoc#_rgant-PropertyLayout_cssClass[properties] and xref:../rgant/rgant.adoc#_rgant-ParameterLayout_cssClass[parameters].
+This attribute can also be applied to:
+
+* xref:../rgant/rgant.adoc#_rgant-DomainObjectLayout_cssClass[domain objects]
+* xref:../rgant/rgant.adoc#_rgant-ViewModelLayout_cssClass[view models]
+* xref:../rgant/rgant.adoc#_rgant-ActionLayout_cssClass[actions]
+* xref:../rgant/rgant.adoc#_rgant-PropertyLayout_cssClass[properties]
+* xref:../rgant/rgant.adoc#_rgant-ParameterLayout_cssClass[parameters].
diff --git a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-CollectionLayout_named.adoc b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-CollectionLayout_named.adoc
index ea087b4..5d33e12 100644
--- a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-CollectionLayout_named.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-CollectionLayout_named.adoc
@@ -46,6 +46,7 @@ The framework also provides a separate, powerful mechanism for xref:../ugbtb/ugb
== See also
This attribute can also be specified for:
+
* xref:../rgant/rgant.adoc#_rgant-ActionLayout_named[actions]
* xref:../rgant/rgant.adoc#_rgant-PropertyLayout_named[properties]
* xref:../rgant/rgant.adoc#_rgant-ParameterLayout_named[parameters]
diff --git a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-Collection_domainEvent.adoc b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-Collection_domainEvent.adoc
index 043652c..6e32cce 100644
--- a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-Collection_domainEvent.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-Collection_domainEvent.adoc
@@ -37,9 +37,6 @@ public class ToDoItem {
----
The `domainEvent()` attribute allows a custom subclass to be emitted allowing more precise subscriptions (to those subclasses) to be defined instead.
-This attribute is also supported for
-xref:../rgant/rgant.adoc#_rgant-Action_domainEvent[actions] and
-xref:../rgant/rgant.adoc#_rgant-Property_domainEvent[properties].
For example:
@@ -168,5 +165,12 @@ Normally events are only raised for interactions through the UI.
However, events can be raised programmatically either by calling the xref:../rgsvc/rgsvc.adoc#_rgsvc_core-domain-api_EventBusService[`EventBusService`] API directly, or by emulating the UI by wrapping the target object using the xref:../rgsvc/rgsvc.adoc#_rgsvc_application-layer-api_WrapperFactory[`WrapperFactory`] domain service.
+== See also
+
+This attribute is also supported for:
+
+* xref:../rgant/rgant.adoc#_rgant-Action_domainEvent[actions] and
+* xref:../rgant/rgant.adoc#_rgant-Property_domainEvent[properties].
+
diff --git a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-Collection_notPersisted.adoc b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-Collection_notPersisted.adoc
index 0a9b149..077ce59 100644
--- a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-Collection_notPersisted.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-Collection_notPersisted.adoc
@@ -6,7 +6,7 @@
-The (somewhat misnamed) `notPersisted()` attribute indicates that the collection should be excluded from any snapshots generated by the xref:../rgsvc/rgsvc.adoc#_rgsvc_integration-api_XmlSnapshotService[`XmlSnapshotService`]. This attribute is also supported for xref:../rgant/rgant.adoc#_rgant-Property_notPersisted[properties].
+The (somewhat misnamed) `notPersisted()` attribute indicates that the collection should be excluded from any snapshots generated by the xref:../rgsvc/rgsvc.adoc#_rgsvc_integration-api_XmlSnapshotService[`XmlSnapshotService`].
[WARNING]
@@ -55,3 +55,9 @@ public class Customer {
...
}
----
+
+
+== See also
+
+This attribute is also supported for xref:../rgant/rgant.adoc#_rgant-Property_notPersisted[properties].
+
diff --git a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-DomainObject_publishing.adoc b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-DomainObject_publishing.adoc
index 3e3e295..a171f6c 100644
--- a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-DomainObject_publishing.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-DomainObject_publishing.adoc
@@ -7,7 +7,7 @@
The `publishing()` attribute determines whether and how a modified object instance is published via the registered implementation of a xref:../rgsvc/rgsvc.adoc#_rgsvc_persistence-layer-spi_PublishingService[`PublishingService`]) or xref:../rgsvc/rgsvc.adoc#_rgsvc_persistence-layer-spi_PublisherService[`PublisherService`].
-This attribute is also supported for xref:../rgant/rgant.adoc#_rgant-Action_publishing[actions], where it controls whether action invocations are published as events, and for xref:../rgant/rgant.adoc#_rgant-Property_publishing[`@Property#publishing()`], where it controls whether property edits are published as events.
+
A common use case is to notify external "downstream" systems of changes in the state of the Apache Isis application.
@@ -54,3 +54,16 @@ For at least some subscribers this should avoid the necessity to query back for
Be aware that this attribute is only honoured by the (deprecated) xref:../rgsvc/rgsvc.adoc#_rgsvc_persistence-layer-spi_PublishingService[`PublishingService`], so should itself be considered as deprecated.
It is ignored by the replacement xref:../rgsvc/rgsvc.adoc#_rgsvc_persistence-layer-spi_PublisherService[`PublisherService`],
====
+
+
+== See also
+
+This attribute is also supported for:
+
+* xref:../rgant/rgant.adoc#_rgant-Action_publishing[actions]
++
+where it controls whether action invocations are published as events, and for
+
+* xref:../rgant/rgant.adoc#_rgant-Property_publishing[properties]
++
+where it controls whether property edits are published as events.
diff --git a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-DomainServiceLayout_named.adoc b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-DomainServiceLayout_named.adoc
index 41dc084..2f034fd 100644
--- a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-DomainServiceLayout_named.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-DomainServiceLayout_named.adoc
@@ -11,7 +11,8 @@ The `named()` attribute explicitly specifies the domain service's name, overridi
[TIP]
====
-The value of this attribute also has an important role to play in the positioning of the domain service's actions relative to the actions of other domain services. See xref:../rgant/rgant.adoc#_rgant-DomainServiceLayout_menuOrder[`menuOrder()`] for a full discussion with examples.
+The value of this attribute also has an important role to play in the positioning of the domain service's actions relative to the actions of other domain services.
+See xref:../rgant/rgant.adoc#_rgant-DomainServiceLayout_menuOrder[`menuOrder()`] for a full discussion with examples.
====
For example:
diff --git a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-ParameterLayout.adoc b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-ParameterLayout.adoc
index bba6565..a0e6b8f 100644
--- a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-ParameterLayout.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-ParameterLayout.adoc
@@ -34,7 +34,8 @@ The table below summarizes the annotation's attributes.
(`LEFT`)
|in forms, the positioning of the label relative to the property value. +
-Default is `LEFT`, unless xref:../rgant/rgant.adoc#_rgant-ParameterLayout_multiLine[`multiLine`] in which case `TOP`. The value `RIGHT` is only supported for boolean parameters.
+Default is `LEFT`, unless xref:../rgant/rgant.adoc#_rgant-ParameterLayout_multiLine[`multiLine`] in which case `TOP`.
+The value `RIGHT` is only supported for boolean parameters.
|xref:../rgant/rgant.adoc#_rgant-ParameterLayout_multiLine[`multiLine()`]
@@ -48,7 +49,8 @@ If set > 1, then then xref:../rgant/rgant.adoc#_rgant-ParameterLayout_labelPosit
|String
|the name of this parameter. +
-For Java 7 this is generally required. For Java 8, the name can often be inferred from the code so this attribute allows the name to be overridden. A typical use case is if the desired name is a reserved Java keyword, such as `default` or `package`.
+For Java 7 this is generally required. For Java 8, the name can often be inferred from the code so this attribute allows the name to be overridden.
+A typical use case is if the desired name is a reserved Java keyword, such as `default` or `package`.
|`namedEscaped()`
diff --git a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-ParameterLayout_renderedAsDayBefore.adoc b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-ParameterLayout_renderedAsDayBefore.adoc
index 8bf1fd5..d0952ac 100644
--- a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-ParameterLayout_renderedAsDayBefore.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-ParameterLayout_renderedAsDayBefore.adoc
@@ -6,9 +6,12 @@
-The `renderedAsDayBefore()` attribute applies only to date parameters whereby the date will be rendered as the day before the value actually held in the domain object. It is ignored for parameters of other types. This attribute is also supported for xref:../rgant/rgant.adoc#_rgant-PropertyLayout_renderedAsDayBefore[properties].
+The `renderedAsDayBefore()` attribute applies only to date parameters whereby the date will be rendered as the day before the value actually held in the domain object.
+It is ignored for parameters of other types.
-This behaviour might at first glance appear odd, but the rationale is to support the use case of a sequence of instances that represent adjacent intervals of time. In such cases there would typically be `startDate` and `endDate` properties, eg for all of Q2. Storing this as a half-closed interval -- eg `[1-Apr-2015, 1-July-2015)` -- can substantially simplify internal algorithms; the `endDate` of one interval will correspond to the `startDate` of the next.
+This behaviour might at first glance appear odd, but the rationale is to support the use case of a sequence of instances that represent adjacent intervals of time.
+In such cases there would typically be `startDate` and `endDate` properties, eg for all of Q2.
+Storing this as a half-closed interval -- eg `[1-Apr-2015, 1-July-2015)` -- can substantially simplify internal algorithms; the `endDate` of one interval will correspond to the `startDate` of the next.
However, from an end-user perspective the requirement may be to render the interval as a fully closed interval; eg the end date should be shown as `30-Jun-2015`.
@@ -33,3 +36,7 @@ public class Tenancy {
----
+== See also
+
+This attribute is also supported for xref:../rgant/rgant.adoc#_rgant-PropertyLayout_renderedAsDayBefore[properties].
+
diff --git a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-ParameterLayout_typicalLength.adoc b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-ParameterLayout_typicalLength.adoc
index 434a776..b82d450 100644
--- a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-ParameterLayout_typicalLength.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-ParameterLayout_typicalLength.adoc
@@ -6,9 +6,12 @@
-The `typicalLength()` attribute indicates the typical length of a string parameter. It is ignored for parameters of other types. The attribute is also supported for xref:../rgant/rgant.adoc#_rgant-PropertyLayout_typicalLength[properties].
+The `typicalLength()` attribute indicates the typical length of a string parameter.
+It is ignored for parameters of other types.
+The attribute is also supported for xref:../rgant/rgant.adoc#_rgant-PropertyLayout_typicalLength[properties].
-The information is intended as a hint to the UI to determine the space that should be given to render a particular string parameter. That said, note that the xref:../ugvw/ugvw.adoc#[Wicket viewer] uses the maximum space available for all fields, so in effect ignores this attribute.
+The information is intended as a hint to the UI to determine the space that should be given to render a particular string parameter.
+That said, note that the xref:../ugvw/ugvw.adoc#[Wicket viewer] uses the maximum space available for all fields, so in effect ignores this attribute.
For example:
diff --git a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-PropertyLayout_renderedAsDayBefore.adoc b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-PropertyLayout_renderedAsDayBefore.adoc
index a393c5b..f07caa8 100644
--- a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-PropertyLayout_renderedAsDayBefore.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-PropertyLayout_renderedAsDayBefore.adoc
@@ -6,9 +6,12 @@
-The `renderedAsDayBefore()` attribute applies only to date properties whereby the date will be rendered as the day before the value actually held in the domain object. It is ignored for properties of other types. This attribute is also supported for xref:../rgant/rgant.adoc#_rgant-ParameterLayout_renderedAsDayBefore[parameters].
+The `renderedAsDayBefore()` attribute applies only to date properties whereby the date will be rendered as the day before the value actually held in the domain object.
+It is ignored for properties of other types.
-This behaviour might at first glance appear odd, but the rationale is to support the use case of a sequence of instances that represent adjacent intervals of time. In such cases there would typically be `startDate` and `endDate` properties, eg for all of Q2. Storing this as a half-closed interval -- eg `[1-Apr-2015, 1-July-2015)` -- can substantially simplify internal algorithms; the `endDate` of one interval will correspond to the `startDate` of the next.
+This behaviour might at first glance appear odd, but the rationale is to support the use case of a sequence of instances that represent adjacent intervals of time.
+In such cases there would typically be `startDate` and `endDate` properties, eg for all of Q2.
+Storing this as a half-closed interval -- eg `[1-Apr-2015, 1-July-2015)` -- can substantially simplify internal algorithms; the `endDate` of one interval will correspond to the `startDate` of the next.
However, from an end-user perspective the requirement may be to render the interval as a fully closed interval; eg the end date should be shown as `30-Jun-2015`.
@@ -35,3 +38,9 @@ public class Tenancy {
== Alternatives
As an alternative to using the annotation, the dynamic xref:../ugvw/ugvw.adoc#_ugvw_layout_file-based[file-based layout] can be used instead.
+
+
+== See also
+
+This attribute is also supported for xref:../rgant/rgant.adoc#_rgant-ParameterLayout_renderedAsDayBefore[parameters].
+
diff --git a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-PropertyLayout_typicalLength.adoc b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-PropertyLayout_typicalLength.adoc
index 32ba1b4..5c16e80 100644
--- a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-PropertyLayout_typicalLength.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-PropertyLayout_typicalLength.adoc
@@ -6,9 +6,12 @@
-The `typicalLength()` attribute indicates the typical length of a string property. It is ignored for properties of other types. The attribute is also supported for xref:../rgant/rgant.adoc#_rgant-ParameterLayout_typicalLength[parameters].
+The `typicalLength()` attribute indicates the typical length of a string property.
+It is ignored for properties of other types.
+The attribute is also supported for xref:../rgant/rgant.adoc#_rgant-ParameterLayout_typicalLength[parameters].
-The information is intended as a hint to the UI to determine the space that should be given to render a particular string property. That said, note that the xref:../ugvw/ugvw.adoc#[Wicket viewer] uses the maximum space available for all fields, so in effect ignores this attribute.
+The information is intended as a hint to the UI to determine the space that should be given to render a particular string property.
+That said, note that the xref:../ugvw/ugvw.adoc#[Wicket viewer] uses the maximum space available for all fields, so in effect ignores this attribute.
For example:
diff --git a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-Property_domainEvent.adoc b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-Property_domainEvent.adoc
index b94f991..bb48c52 100644
--- a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-Property_domainEvent.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-Property_domainEvent.adoc
@@ -29,7 +29,6 @@ public class ToDoItem {
----
The `domainEvent()` attribute allows a custom subclass to be emitted allowing more precise subscriptions (to those subclasses) to be defined instead.
-This attribute is also supported for xref:../rgant/rgant.adoc#_rgant-Action_domainEvent[actions] and xref:../rgant/rgant.adoc#_rgant-Property_domainEvent[properties].
For example:
@@ -148,3 +147,11 @@ And, conversely, the framework also provides `PropertyDomainEvent.Noop`; if `dom
Normally events are only raised for interactions through the UI.
However, events can be raised programmatically by wrapping the target object using the xref:../rgsvc/rgsvc.adoc#_rgsvc_application-layer-api_WrapperFactory[`WrapperFactory`] service.
+
+== See also
+
+This attribute is also supported for:
+
+* xref:../rgant/rgant.adoc#_rgant-Action_domainEvent[actions] and
+* xref:../rgant/rgant.adoc#_rgant-Property_domainEvent[properties].
+
diff --git a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-Property_notPersisted.adoc b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-Property_notPersisted.adoc
index 77b96de..e358c57 100644
--- a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-Property_notPersisted.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-Property_notPersisted.adoc
@@ -8,7 +8,6 @@
The (somewhat misnamed) `notPersisted()` attribute indicates that the collection should be excluded from any snapshots generated by the xref:../rgsvc/rgsvc.adoc#_rgsvc_integration-api_XmlSnapshotService[`XmlSnapshotService`].
-This attribute is also supported for xref:../rgant/rgant.adoc#_rgant-Collection_notPersisted[collections].
[WARNING]
@@ -63,3 +62,8 @@ public class Order {
}
----
+
+== See also
+
+This attribute is also supported for xref:../rgant/rgant.adoc#_rgant-Collection_notPersisted[collections].
+
diff --git a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-Property_publishing.adoc b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-Property_publishing.adoc
index abce96e..17a1eef 100644
--- a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-Property_publishing.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-Property_publishing.adoc
@@ -8,7 +8,6 @@
The `publishing()` attribute determines whether and how a property edit is published via the registered implementation of a xref:../rgsvc/rgsvc.adoc#_rgsvc_persistence-layer-spi_PublishingService[`PublishingService`]) or xref:../rgsvc/rgsvc.adoc#_rgsvc_persistence-layer-spi_PublisherService[`PublisherService`].
-This attribute is also supported for xref:../rgant/rgant.adoc#_rgant-DomainObject_publishing[domain objects], where it controls whether changed objects are published as events, and for xref:../rgant/rgant.adoc#_rgant-Property_publishing[`@Property#publishing()`], where it controls whether property edits are published as events.
A common use case is to notify external "downstream" systems of changes in the state of the Apache Isis application.
The default value for the attribute is `AS_CONFIGURED`, meaning that the
@@ -41,3 +40,15 @@ public class Order {
----
<1> because set to enabled, will be published irrespective of the configured value.
+
+== See also
+
+This attribute can also be specified for:
+
+* xref:../rgant/rgant.adoc#_rgant-DomainObject_publishing[domain objects]
++
+where it controls whether changed objects are published as events, and for
+
+* xref:../rgant/rgant.adoc#_rgant-Action_publishing[actions]
++
+where it controls whether action invocations are published as events.