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 2020/01/21 16:09:36 UTC
[isis] 11/11: ISIS-2264: updates 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 e1088f072c4203cf2158bd2150203fdf4c44693a
Author: danhaywood <da...@haywood-associates.co.uk>
AuthorDate: Tue Jan 21 16:08:36 2020 +0000
ISIS-2264: updates docs
---
.../applib-ant/examples/annotation/Nature.java | 6 +-
.../examples/services/factory/FactoryService.java | 3 +
.../config/examples/generated/isis.applib.adoc | 112 ++++++++++-----------
.../isis.core.meta-model.introspector.adoc | 6 +-
.../generated/isis.core.meta-model.validator.adoc | 12 +--
.../generated/isis.core.runtime-services.adoc | 8 +-
.../examples/generated/isis.core.runtime.adoc | 2 +-
.../isis.persistence.jdo-datanucleus.impl.adoc | 28 +++---
.../generated/isis.viewer.restfulobjects.adoc | 2 +-
.../examples/generated/isis.viewer.wicket.adoc | 30 +++---
.../apache/isis/core/config/IsisConfiguration.java | 23 +++--
scripts/generateConfigDocs.groovy | 6 +-
12 files changed, 127 insertions(+), 111 deletions(-)
diff --git a/api/applib/src/main/adoc/modules/applib-ant/examples/annotation/Nature.java b/api/applib/src/main/adoc/modules/applib-ant/examples/annotation/Nature.java
index 4ffa704..fcb6fc1 100644
--- a/api/applib/src/main/adoc/modules/applib-ant/examples/annotation/Nature.java
+++ b/api/applib/src/main/adoc/modules/applib-ant/examples/annotation/Nature.java
@@ -70,8 +70,8 @@ public enum Nature {
* constructed from some sort of internal memory data structure.
*
* <p>
- * As for a {@link #EXTERNAL_ENTITY}, the identity of a synthetic entity is determined solely by the state of
- * object's properties (that have not been set to be ignored using
+ * As for a {@link #EXTERNAL_ENTITY}, the identity of a synthetic entity is determined solely by the
+ * state of object's properties (that have not been set to be ignored using
* {@link org.apache.isis.applib.annotation.Property#notPersisted()}).
* </p>
*
@@ -82,7 +82,7 @@ public enum Nature {
*/
INMEMORY_ENTITY,
/**
- * An object that is conceptually part of the application layer, and which surfaces behaviour and/or state that
+ * An object that is conceptually part of the application layer, and which surfaces behavior and/or state that
* is aggregate of one or more domain entity.
*
* <p>
diff --git a/api/applib/src/main/adoc/modules/applib-svc/examples/services/factory/FactoryService.java b/api/applib/src/main/adoc/modules/applib-svc/examples/services/factory/FactoryService.java
index f13919e..a3eaa5e 100644
--- a/api/applib/src/main/adoc/modules/applib-svc/examples/services/factory/FactoryService.java
+++ b/api/applib/src/main/adoc/modules/applib-svc/examples/services/factory/FactoryService.java
@@ -53,6 +53,7 @@ public interface FactoryService {
* @param mixinClass
* @param mixedIn
* @return
+ * @apiNote forces the mixinClass to be added to the meta-model if not already
*/
<T> T mixin(Class<T> mixinClass, Object mixedIn);
@@ -60,6 +61,7 @@ public interface FactoryService {
* Creates a new ViewModel instance, and initializes according to the given {@code mementoStr}
* @param viewModelClass
* @param mementoStr - ignored if {@code null}
+ * @apiNote forces the viewModelClass to be added to the meta-model if not already
* @since 2.0
*/
<T> T viewModel(Class<T> viewModelClass, @Nullable String mementoStr);
@@ -67,6 +69,7 @@ public interface FactoryService {
/**
* Creates a new ViewModel instance
* @param viewModelClass
+ * @apiNote forces the viewModelClass to be added to the meta-model if not already
* @since 2.0
*/
default <T> T viewModel(Class<T> viewModelClass) {
diff --git a/core/config/src/main/adoc/modules/config/examples/generated/isis.applib.adoc b/core/config/src/main/adoc/modules/config/examples/generated/isis.applib.adoc
index 3a010de..a77d788 100644
--- a/core/config/src/main/adoc/modules/config/examples/generated/isis.applib.adoc
+++ b/core/config/src/main/adoc/modules/config/examples/generated/isis.applib.adoc
@@ -6,7 +6,7 @@ patterns
Providing a default set of patterns encourages a common set of verbs to be used.
-The font awesome class for individual actions can be overridden using `org.apache.isis.applib.annotation.ActionLayout#cssClassFa()`.
+The font awesome class for individual actions can be overridden using ``org.apache.isis.applib.annotation.ActionLayout#cssClassFa()``.
| isis.applib.annotation. +
@@ -17,27 +17,27 @@ patterns
Providing a default set of patterns encourages a common set of verbs to be used.
-The CSS class for individual actions can be overridden using `org.apache.isis.applib.annotation.ActionLayout#cssClass()`.
+The CSS class for individual actions can be overridden using ``org.apache.isis.applib.annotation.ActionLayout#cssClass()``.
| isis.applib.annotation.action. +
command
|
-| The default for whether action invocations should be reified as a `org.apache.isis.applib.services.command.Command` using the `org.apache.isis.applib.services.command.spi.CommandService`, possibly so that the actual execution of the action can be deferred until later (background execution) or replayed against a copy of the system.
+| The default for whether action invocations should be reified as a ``org.apache.isis.applib.services.command.Command`` using the ``org.apache.isis.applib.services.command.spi.CommandService``, possibly so that the actual execution of the action can be deferred until later (background execution) or replayed against a copy of the system.
-In particular, the `org.apache.isis.applib.services.command.CommandWithDto` implementation of `org.apache.isis.applib.services.command.Command` represents the action invocation memento (obtained using `CommandWithDto#asDto()`) as a `org.apache.isis.schema.cmd.v2.CommandDto`.
+In particular, the ``org.apache.isis.applib.services.command.CommandWithDto`` implementation of ``org.apache.isis.applib.services.command.Command`` represents the action invocation memento (obtained using ``CommandWithDto#asDto()``) as a ``org.apache.isis.schema.cmd.v2.CommandDto``.
-This setting can be overridden on a case-by-case basis using `org.apache.isis.applib.annotation.Action#command()`.
+This setting can be overridden on a case-by-case basis using ``org.apache.isis.applib.annotation.Action#command()``.
| isis.applib.annotation.action. +
domain-event.post-for-default
| true
-| Influences whether an `org.apache.isis.applib.events.domain.ActionDomainEvent` should be published (on the internal `org.apache.isis.applib.services.eventbus.EventBusService`) whenever an action is being interacted with.
+| Influences whether an ``org.apache.isis.applib.events.domain.ActionDomainEvent`` should be published (on the internal ``org.apache.isis.applib.services.eventbus.EventBusService``) whenever an action is being interacted with.
Up to five different events can be fired during an interaction, with the event's phase determining which (hide, disable, validate, executing and executed). Subscribers can influence the behaviour at each of these phases.
-The algorithm for determining whether (and what type of) an event is actually sent depends on the value of the `org.apache.isis.applib.annotation.Action#domainEvent()` for the action in question:
+The algorithm for determining whether (and what type of) an event is actually sent depends on the value of the ``org.apache.isis.applib.annotation.Action#domainEvent()`` for the action in question:
* If set to some subtype of ActionDomainEvent.Noop, then _no_ event is sent.
* If set to some subtype of ActionDomainEvent.Default, then an event is sent _if and only if_ this configuration setting is set.
@@ -47,17 +47,17 @@ The algorithm for determining whether (and what type of) an event is actually se
| isis.applib.annotation.action. +
explicit
|
-| Whether or not a public method needs to be annotated with @`org.apache.isis.applib.annotation.Action` in order to be picked up as an action in the metamodel.
+| Whether or not a public method needs to be annotated with @``org.apache.isis.applib.annotation.Action`` in order to be picked up as an action in the metamodel.
| isis.applib.annotation.action. +
publishing
|
-| The default for whether action invocations should be sent through to the `org.apache.isis.applib.services.publish.PublisherService` for publishing.
+| The default for whether action invocations should be sent through to the ``org.apache.isis.applib.services.publish.PublisherService`` for publishing.
-The service's publish method is called only once per transaction, with `org.apache.isis.applib.services.iactn.Interaction.Execution` collecting details of the identity of the target object, the action invoked, the action arguments and the returned object (if any).
+The service's publish method is called only once per transaction, with ``org.apache.isis.applib.services.iactn.Interaction.Execution`` collecting details of the identity of the target object, the action invoked, the action arguments and the returned object (if any).
-This setting can be overridden on a case-by-case basis using `org.apache.isis.applib.annotation.Action#publishing()`.
+This setting can be overridden on a case-by-case basis using ``org.apache.isis.applib.annotation.Action#publishing()``.
| isis.applib.annotation. +
@@ -66,7 +66,7 @@ default-view
|
| Defines the initial view to display collections when rendered.
-The value of this can be overridden on a case-by-case basis using `org.apache.isis.applib.annotation.CollectionLayout#defaultView()`. Note that this default configuration property is an enum and so defines only a fixed number of values, whereas the annotation returns a string; this is to allow for flexibility that individual viewers might support their own additional types. For example, the Wicket viewer supports which can render objects that have a date on top of a calendar view.
+The value of this can be overridden on a case-by-case basis using ``org.apache.isis.applib.annotation.CollectionLayout#defaultView()``. Note that this default configuration property is an enum and so defines only a fixed number of values, whereas the annotation returns a string; this is to allow for flexibility that individual viewers might support their own additional types. For example, the Wicket viewer supports which can render objects that have a date on top of a calendar view.
| isis.applib.annotation. +
@@ -74,18 +74,18 @@ collection-layout.paged
| 12
| Defines the default number of objects that are shown in a "parented" collection of a domain object, result of invoking an action.
-This can be overridden on a case-by-case basis using `org.apache.isis.applib.annotation.CollectionLayout#paged()`.
+This can be overridden on a case-by-case basis using ``org.apache.isis.applib.annotation.CollectionLayout#paged()``.
| isis.applib.annotation. +
collection.domain-event. +
post-for-default
| true
-| Influences whether an `org.apache.isis.applib.events.domain.CollectionDomainEvent` should be published (on the internal `org.apache.isis.applib.services.eventbus.EventBusService`) whenever a collection is being interacted with.
+| Influences whether an ``org.apache.isis.applib.events.domain.CollectionDomainEvent`` should be published (on the internal ``org.apache.isis.applib.services.eventbus.EventBusService``) whenever a collection is being interacted with.
Up to two different events can be fired during an interaction, with the event's phase determining which (hide, disable)Subscribers can influence the behaviour at each of these phases.
-The algorithm for determining whether (and what type of) an event is actually sent depends on the value of the `org.apache.isis.applib.annotation.Collection#domainEvent()` for the collection action in question:
+The algorithm for determining whether (and what type of) an event is actually sent depends on the value of the ``org.apache.isis.applib.annotation.Collection#domainEvent()`` for the collection action in question:
* If set to some subtype of CollectionDomainEvent.Noop, then _no_ event is sent.
* If set to some subtype of CollectionDomainEvent.Default, then an event is sent _if and only if_ this configuration setting is set.
@@ -97,9 +97,9 @@ domain-object-layout. +
css-class-ui-event. +
post-for-default
| true
-| Influences whether an `org.apache.isis.applib.events.ui.CssClassUiEvent` should be published (on the internal `org.apache.isis.applib.services.eventbus.EventBusService`) whenever a domain object is about to be rendered in the UI - thereby allowing subscribers to optionally `org.apache.isis.applib.events.ui.CssClassUiEvent#setCssClass(String)` change) the CSS classes that are used.
+| Influences whether an ``org.apache.isis.applib.events.ui.CssClassUiEvent`` should be published (on the internal ``org.apache.isis.applib.services.eventbus.EventBusService``) whenever a domain object is about to be rendered in the UI - thereby allowing subscribers to optionally ``org.apache.isis.applib.events.ui.CssClassUiEvent#setCssClass(String)`` change) the CSS classes that are used.
-The algorithm for determining whether (and what type of) an event is sent depends on the value of the `org.apache.isis.applib.annotation.DomainObjectLayout#cssClassUiEvent()` @DomainObjectLayout(cssClassEvent=...)} for the domain object in question.
+The algorithm for determining whether (and what type of) an event is sent depends on the value of the ``org.apache.isis.applib.annotation.DomainObjectLayout#cssClassUiEvent()`` @DomainObjectLayout(cssClassEvent=...)} for the domain object in question.
* If set to some subtype of CssClassUiEvent.Noop, then _no_ event is sent.
* If set to some subtype of CssClassUiEvent.Default, then an event is sent _if and only if_ this configuration setting is set.
@@ -111,9 +111,9 @@ domain-object-layout. +
icon-ui-event. +
post-for-default
| true
-| Influences whether an `org.apache.isis.applib.events.ui.IconUiEvent` should be published (on the internal `org.apache.isis.applib.services.eventbus.EventBusService`) whenever a domain object is about to be rendered in the UI - thereby allowing subscribers to optionally `org.apache.isis.applib.events.ui.IconUiEvent#setIconName(String)` change) the icon that is used.
+| Influences whether an ``org.apache.isis.applib.events.ui.IconUiEvent`` should be published (on the internal ``org.apache.isis.applib.services.eventbus.EventBusService``) whenever a domain object is about to be rendered in the UI - thereby allowing subscribers to optionally ``org.apache.isis.applib.events.ui.IconUiEvent#setIconName(String)`` change) the icon that is used.
-The algorithm for determining whether (and what type of) an event is sent depends on the value of the `org.apache.isis.applib.annotation.DomainObjectLayout#iconUiEvent()` @DomainObjectLayout(iconEvent=...)} for the domain object in question.
+The algorithm for determining whether (and what type of) an event is sent depends on the value of the ``org.apache.isis.applib.annotation.DomainObjectLayout#iconUiEvent()`` @DomainObjectLayout(iconEvent=...)} for the domain object in question.
* If set to some subtype of IconUiEvent.Noop, then _no_ event is sent.
* If set to some subtype of IconUiEvent.Default, then an event is sent _if and only if_ this configuration setting is set.
@@ -125,11 +125,11 @@ domain-object-layout. +
layout-ui-event. +
post-for-default
| true
-| Influences whether an `org.apache.isis.applib.events.ui.LayoutUiEvent` should be published (on the internal `org.apache.isis.applib.services.eventbus.EventBusService`) whenever a domain object is about to be rendered in the UI - thereby allowing subscribers to optionally `org.apache.isis.applib.events.ui.LayoutUiEvent#setLayout(String)` change) the layout that is used.
+| Influences whether an ``org.apache.isis.applib.events.ui.LayoutUiEvent`` should be published (on the internal ``org.apache.isis.applib.services.eventbus.EventBusService``) whenever a domain object is about to be rendered in the UI - thereby allowing subscribers to optionally ``org.apache.isis.applib.events.ui.LayoutUiEvent#setLayout(String)`` change) the layout that is used.
If a different layout value has been set, then a layout in the form `Xxx.layout-zzz.xml` use used (where `zzz` is the name of the layout).
-The algorithm for determining whether (and what type of) an event is sent depends on the value of the `org.apache.isis.applib.annotation.DomainObjectLayout#layoutUiEvent()` @DomainObjectLayout(layoutEvent=...)} for the domain object in question.
+The algorithm for determining whether (and what type of) an event is sent depends on the value of the ``org.apache.isis.applib.annotation.DomainObjectLayout#layoutUiEvent()`` @DomainObjectLayout(layoutEvent=...)} for the domain object in question.
* If set to some subtype of LayoutUiEvent.Noop, then _no_ event is sent.
* If set to some subtype of LayoutUiEvent.Default, then an event is sent _if and only if_ this configuration setting is set.
@@ -141,7 +141,7 @@ domain-object-layout.paged
| 25
| Defines the default number of objects that are shown in a "standalone" collection obtained as the result of invoking an action.
-This can be overridden on a case-by-case basis using `org.apache.isis.applib.annotation.DomainObjectLayout#paged()`.
+This can be overridden on a case-by-case basis using ``org.apache.isis.applib.annotation.DomainObjectLayout#paged()``.
| isis.applib.annotation. +
@@ -149,9 +149,9 @@ domain-object-layout. +
title-ui-event. +
post-for-default
| true
-| Influences whether an `org.apache.isis.applib.events.ui.TitleUiEvent` should be published (on the internal `org.apache.isis.applib.services.eventbus.EventBusService`) whenever a domain object is about to be rendered in the UI - thereby allowing subscribers to optionally `org.apache.isis.applib.events.ui.TitleUiEvent#setTitle(String)` change) the title that is used.
+| Influences whether an ``org.apache.isis.applib.events.ui.TitleUiEvent`` should be published (on the internal ``org.apache.isis.applib.services.eventbus.EventBusService``) whenever a domain object is about to be rendered in the UI - thereby allowing subscribers to optionally ``org.apache.isis.applib.events.ui.TitleUiEvent#setTitle(String)`` change) the title that is used.
-The algorithm for determining whether (and what type of) an event is sent depends on the value of the `org.apache.isis.applib.annotation.DomainObjectLayout#titleUiEvent()` @DomainObjectLayout(titleEvent=...)} for the domain object in question.
+The algorithm for determining whether (and what type of) an event is sent depends on the value of the ``org.apache.isis.applib.annotation.DomainObjectLayout#titleUiEvent()`` @DomainObjectLayout(titleEvent=...)} for the domain object in question.
* If set to some subtype of TitleUiEvent.Noop, then _no_ event is sent.
* If set to some subtype of TitleUiEvent.Default, then an event is sent _if and only if_ this configuration setting is set.
@@ -161,9 +161,9 @@ The algorithm for determining whether (and what type of) an event is sent depend
| isis.applib.annotation. +
domain-object.auditing
|
-| The default for whether _domain entities_ should be audited or not (meaning that any changes are sent through to the `org.apache.isis.applib.services.audit.AuditerService`.
+| The default for whether _domain entities_ should be audited or not (meaning that any changes are sent through to the ``org.apache.isis.applib.services.audit.AuditerService``.
-This setting can be overridden on a case-by-case basis using `org.apache.isis.applib.annotation.DomainObject#auditing()` DomainObject#getAuditing()}
+This setting can be overridden on a case-by-case basis using ``org.apache.isis.applib.annotation.DomainObject#auditing()`` DomainObject#getAuditing()}
Note: this applies only to domain entities, not view models.
@@ -173,7 +173,7 @@ domain-object. +
created-lifecycle-event. +
post-for-default
| true
-| Influences whether an `org.apache.isis.applib.events.lifecycle.ObjectCreatedEvent` should be published (on the internal `org.apache.isis.applib.services.eventbus.EventBusService`) whenever a domain object has been created using `org.apache.isis.applib.services.factory.FactoryService`.
+| Influences whether an ``org.apache.isis.applib.events.lifecycle.ObjectCreatedEvent`` should be published (on the internal ``org.apache.isis.applib.services.eventbus.EventBusService``) whenever a domain object has been created using ``org.apache.isis.applib.services.factory.FactoryService``.
The algorithm for determining whether (and what type of) an event is sent depends on the value of the @DomainObject(createdLifecycleEvent=...) for the domain object in question.
@@ -195,7 +195,7 @@ domain-object. +
loaded-lifecycle-event. +
post-for-default
| true
-| Influences whether an `org.apache.isis.applib.events.lifecycle.ObjectLoadedEvent` should be published (on the internal `org.apache.isis.applib.services.eventbus.EventBusService`) whenever a domain _entity_ has been loaded from the persistence store.
+| Influences whether an ``org.apache.isis.applib.events.lifecycle.ObjectLoadedEvent`` should be published (on the internal ``org.apache.isis.applib.services.eventbus.EventBusService``) whenever a domain _entity_ has been loaded from the persistence store.
The algorithm for determining whether (and what type of) an event is sent depends on the value of the @DomainObject(loadedLifecycleEvent=...) for the domain object in question.
@@ -211,7 +211,7 @@ domain-object. +
persisted-lifecycle-event. +
post-for-default
| true
-| Influences whether an `org.apache.isis.applib.events.lifecycle.ObjectPersistedEvent` should be published (on the internal `org.apache.isis.applib.services.eventbus.EventBusService`) whenever a domain _entity_ has been persisted (for the first time) to the persistence store.
+| Influences whether an ``org.apache.isis.applib.events.lifecycle.ObjectPersistedEvent`` should be published (on the internal ``org.apache.isis.applib.services.eventbus.EventBusService``) whenever a domain _entity_ has been persisted (for the first time) to the persistence store.
The algorithm for determining whether (and what type of) an event is sent depends on the value of the @DomainObject(persistedLifecycleEvent=...) for the domain object in question.
@@ -227,7 +227,7 @@ domain-object. +
persisting-lifecycle-event. +
post-for-default
| true
-| Influences whether an `org.apache.isis.applib.events.lifecycle.ObjectPersistingEvent` should be published (on the internal `org.apache.isis.applib.services.eventbus.EventBusService`) whenever a domain _entity_ is about to be persisting (for the first time) to the persistence store.
+| Influences whether an ``org.apache.isis.applib.events.lifecycle.ObjectPersistingEvent`` should be published (on the internal ``org.apache.isis.applib.services.eventbus.EventBusService``) whenever a domain _entity_ is about to be persisting (for the first time) to the persistence store.
The algorithm for determining whether (and what type of) an event is sent depends on the value of the @DomainObject(persistingLifecycleEvent=...) for the domain object in question.
@@ -241,11 +241,11 @@ Note: this applies only to domain entities, not to view models.
| isis.applib.annotation. +
domain-object.publishing
|
-| The default for whether the identities of changed objects should be sent through to the `org.apache.isis.applib.services.publish.PublisherService` for publishing.
+| The default for whether the identities of changed objects should be sent through to the ``org.apache.isis.applib.services.publish.PublisherService`` for publishing.
-The service's publish method is called only once per transaction, with `PublishedObjects` collecting details of all changed domain objects.
+The service's publish method is called only once per transaction, with ``PublishedObjects`` collecting details of all changed domain objects.
-This setting can be overridden on a case-by-case basis using `org.apache.isis.applib.annotation.DomainObject#publishing()`.
+This setting can be overridden on a case-by-case basis using ``org.apache.isis.applib.annotation.DomainObject#publishing()``.
| isis.applib.annotation. +
@@ -253,7 +253,7 @@ domain-object. +
removing-lifecycle-event. +
post-for-default
| true
-| Influences whether an `org.apache.isis.applib.events.lifecycle.ObjectRemovingEvent` should be published (on the internal `org.apache.isis.applib.services.eventbus.EventBusService`) whenever a persistent domain _entity_ is about to be removed (that is, deleted) from the persistence store.
+| Influences whether an ``org.apache.isis.applib.events.lifecycle.ObjectRemovingEvent`` should be published (on the internal ``org.apache.isis.applib.services.eventbus.EventBusService``) whenever a persistent domain _entity_ is about to be removed (that is, deleted) from the persistence store.
The algorithm for determining whether (and what type of) an event is sent depends on the value of the @DomainObject(removingLifecycleEvent=...) for the domain object in question.
@@ -271,7 +271,7 @@ domain-object. +
updated-lifecycle-event. +
post-for-default
| true
-| Influences whether an `org.apache.isis.applib.events.lifecycle.ObjectUpdatedEvent` should be published (on the internal `org.apache.isis.applib.services.eventbus.EventBusService`) whenever a persistent domain _entity_ has been updated in the persistence store.
+| Influences whether an ``org.apache.isis.applib.events.lifecycle.ObjectUpdatedEvent`` should be published (on the internal ``org.apache.isis.applib.services.eventbus.EventBusService``) whenever a persistent domain _entity_ has been updated in the persistence store.
The algorithm for determining whether (and what type of) an event is sent depends on the value of the @DomainObject(updatedLifecycleEvent=...) for the domain object in question.
@@ -287,7 +287,7 @@ domain-object. +
updating-lifecycle-event. +
post-for-default
| true
-| Influences whether an `org.apache.isis.applib.events.lifecycle.ObjectUpdatingEvent` should be published (on the internal `org.apache.isis.applib.services.eventbus.EventBusService`) whenever a persistent domain _entity_ is about to be updated in the persistence store.
+| Influences whether an ``org.apache.isis.applib.events.lifecycle.ObjectUpdatingEvent`` should be published (on the internal ``org.apache.isis.applib.services.eventbus.EventBusService``) whenever a persistent domain _entity_ is about to be updated in the persistence store.
The algorithm for determining whether (and what type of) an event is sent depends on the value of the @DomainObject(updatingLifecycleEvent=...) for the domain object in question.
@@ -304,9 +304,9 @@ label-position
|
| Defines the default position for the label for an action parameter.
-Can be overridden on a case-by-case basis using `org.apache.isis.applib.annotation.ParameterLayout#labelPosition()`.
+Can be overridden on a case-by-case basis using ``org.apache.isis.applib.annotation.ParameterLayout#labelPosition()``.
-If left as `LabelPosition#NOT_SPECIFIED` and not overridden, then the position depends upon the viewer implementation.
+If left as ``LabelPosition#NOT_SPECIFIED`` and not overridden, then the position depends upon the viewer implementation.
| isis.applib.annotation. +
@@ -315,30 +315,30 @@ label-position
|
| Defines the default position for the label for a domain object property.
-Can be overridden on a case-by-case basis using `org.apache.isis.applib.annotation.ParameterLayout#labelPosition()`.
+Can be overridden on a case-by-case basis using ``org.apache.isis.applib.annotation.ParameterLayout#labelPosition()``.
-If left as `LabelPosition#NOT_SPECIFIED` and not overridden, then the position depends upon the viewer implementation.
+If left as ``LabelPosition#NOT_SPECIFIED`` and not overridden, then the position depends upon the viewer implementation.
| isis.applib.annotation. +
property.command
|
-| The default for whether property edits should be reified as a `org.apache.isis.applib.services.command.Command` using the `org.apache.isis.applib.services.command.spi.CommandService`, possibly so that the actual execution of the property edit can be deferred until later (background execution) or replayed against a copy of the system.
+| The default for whether property edits should be reified as a ``org.apache.isis.applib.services.command.Command`` using the ``org.apache.isis.applib.services.command.spi.CommandService``, possibly so that the actual execution of the property edit can be deferred until later (background execution) or replayed against a copy of the system.
-In particular, the `org.apache.isis.applib.services.command.CommandWithDto` implementation of `org.apache.isis.applib.services.command.Command` represents the action invocation memento (obtained using `CommandWithDto#asDto()`) as a `org.apache.isis.schema.cmd.v2.CommandDto`.
+In particular, the ``org.apache.isis.applib.services.command.CommandWithDto`` implementation of ``org.apache.isis.applib.services.command.Command`` represents the action invocation memento (obtained using ``CommandWithDto#asDto()``) as a ``org.apache.isis.schema.cmd.v2.CommandDto``.
-This setting can be overridden on a case-by-case basis using `org.apache.isis.applib.annotation.Action#command()`.
+This setting can be overridden on a case-by-case basis using ``org.apache.isis.applib.annotation.Action#command()``.
| isis.applib.annotation. +
property.domain-event. +
post-for-default
| true
-| Influences whether an `org.apache.isis.applib.events.domain.PropertyDomainEvent` should be published (on the internal `org.apache.isis.applib.services.eventbus.EventBusService`) whenever an property is being interacted with.
+| Influences whether an ``org.apache.isis.applib.events.domain.PropertyDomainEvent`` should be published (on the internal ``org.apache.isis.applib.services.eventbus.EventBusService``) whenever an property is being interacted with.
Up to five different events can be fired during an interaction, with the event's phase determining which (hide, disable, validate, executing and executed). Subscribers can influence the behaviour at each of these phases.
-The algorithm for determining whether (and what type of) an event is actually sent depends on the value of the `org.apache.isis.applib.annotation.Property#domainEvent()` for the property in question:
+The algorithm for determining whether (and what type of) an event is actually sent depends on the value of the ``org.apache.isis.applib.annotation.Property#domainEvent()`` for the property in question:
* If set to some subtype of propertyDomainEvent.Noop, then _no_ event is sent.
* If set to some subtype of propertyDomainEvent.Default, then an event is sent _if and only if_ this configuration setting is set.
@@ -348,9 +348,9 @@ The algorithm for determining whether (and what type of) an event is actually se
| isis.applib.annotation. +
property.publishing
|
-| The default for whether property edits should be sent through to the `org.apache.isis.applib.services.publish.PublisherService` for publishing.
+| The default for whether property edits should be sent through to the ``org.apache.isis.applib.services.publish.PublisherService`` for publishing.
-The service's publish method is called only once per transaction, with `org.apache.isis.applib.services.iactn.Interaction.Execution` collecting details of the identity of the target object, the property edited, and the new value of the property.
+The service's publish method is called only once per transaction, with ``org.apache.isis.applib.services.iactn.Interaction.Execution`` collecting details of the identity of the target object, the property edited, and the new value of the property.
This setting can be overridden on a case-by-case basis using \{ @link org.apache.isis.applib.annotation.Property#publishing()}.
@@ -360,9 +360,9 @@ view-model-layout. +
css-class-ui-event. +
post-for-default
| true
-| Influences whether an `org.apache.isis.applib.events.ui.CssClassUiEvent` should be published (on the internal `org.apache.isis.applib.services.eventbus.EventBusService`) whenever a view model (annotated with @ViewModel) is about to be rendered in the UI - thereby allowing subscribers to optionally `org.apache.isis.applib.events.ui.CssClassUiEvent#setCssClass(String)` change) the CSS classes that are used.
+| Influences whether an ``org.apache.isis.applib.events.ui.CssClassUiEvent`` should be published (on the internal ``org.apache.isis.applib.services.eventbus.EventBusService``) whenever a view model (annotated with @ViewModel) is about to be rendered in the UI - thereby allowing subscribers to optionally ``org.apache.isis.applib.events.ui.CssClassUiEvent#setCssClass(String)`` change) the CSS classes that are used.
-The algorithm for determining whether (and what type of) an event is sent depends on the value of the `org.apache.isis.applib.annotation.ViewModelLayout#cssClassUiEvent()` @ViewModelLayout(cssClassEvent=...)} for the domain object in question:
+The algorithm for determining whether (and what type of) an event is sent depends on the value of the ``org.apache.isis.applib.annotation.ViewModelLayout#cssClassUiEvent()`` @ViewModelLayout(cssClassEvent=...)} for the domain object in question:
* If set to some subtype of CssClassUiEvent.Noop, then _no_ event is sent.
* If set to some subtype of CssClassUiEvent.Default, then an event is sent _if and only if_ this configuration setting is set.
@@ -374,9 +374,9 @@ view-model-layout. +
icon-ui-event. +
post-for-default
| true
-| Influences whether an `org.apache.isis.applib.events.ui.IconUiEvent` should be published (on the internal `org.apache.isis.applib.services.eventbus.EventBusService`) whenever a view model (annotated with @ViewModel) is about to be rendered in the UI - thereby allowing subscribers to optionally `org.apache.isis.applib.events.ui.IconUiEvent#setIconName(String)` change) the icon that is used.
+| Influences whether an ``org.apache.isis.applib.events.ui.IconUiEvent`` should be published (on the internal ``org.apache.isis.applib.services.eventbus.EventBusService``) whenever a view model (annotated with @ViewModel) is about to be rendered in the UI - thereby allowing subscribers to optionally ``org.apache.isis.applib.events.ui.IconUiEvent#setIconName(String)`` change) the icon that is used.
-The algorithm for determining whether (and what type of) an event is sent depends on the value of the `org.apache.isis.applib.annotation.ViewModelLayout#iconUiEvent()` @ViewModelLayout(iconEvent=...)} for the domain object in question:
+The algorithm for determining whether (and what type of) an event is sent depends on the value of the ``org.apache.isis.applib.annotation.ViewModelLayout#iconUiEvent()`` @ViewModelLayout(iconEvent=...)} for the domain object in question:
* If set to some subtype of IconUiEvent.Noop, then _no_ event is sent.
* If set to some subtype of IconUiEvent.Default, then an event is sent _if and only if_ this configuration setting is set.
@@ -388,11 +388,11 @@ view-model-layout. +
layout-ui-event. +
post-for-default
| true
-| Influences whether an `org.apache.isis.applib.events.ui.LayoutUiEvent` should be published (on the internal `org.apache.isis.applib.services.eventbus.EventBusService`) whenever a view model (annotated with @ViewModel) is about to be rendered in the UI - thereby allowing subscribers to optionally `org.apache.isis.applib.events.ui.LayoutUiEvent#setLayout(String)` change) the layout that is used.
+| Influences whether an ``org.apache.isis.applib.events.ui.LayoutUiEvent`` should be published (on the internal ``org.apache.isis.applib.services.eventbus.EventBusService``) whenever a view model (annotated with @ViewModel) is about to be rendered in the UI - thereby allowing subscribers to optionally ``org.apache.isis.applib.events.ui.LayoutUiEvent#setLayout(String)`` change) the layout that is used.
If a different layout value has been set, then a layout in the form `Xxx.layout-zzz.xml` use used (where `zzz` is the name of the layout).
-The algorithm for determining whether (and what type of) an event is sent depends on the value of the `org.apache.isis.applib.annotation.ViewModelLayout#layoutUiEvent()` @ViewModelLayout(layoutEvent=...)} for the domain object in question:
+The algorithm for determining whether (and what type of) an event is sent depends on the value of the ``org.apache.isis.applib.annotation.ViewModelLayout#layoutUiEvent()`` @ViewModelLayout(layoutEvent=...)} for the domain object in question:
* If set to some subtype of LayoutUiEvent.Noop, then _no_ event is sent.
* If set to some subtype of LayoutUiEvent.Default, then an event is sent _if and only if_ this configuration setting is set.
@@ -404,9 +404,9 @@ view-model-layout. +
title-ui-event. +
post-for-default
| true
-| Influences whether an `org.apache.isis.applib.events.ui.TitleUiEvent` should be published (on the internal `org.apache.isis.applib.services.eventbus.EventBusService`) whenever a view model (annotated with @ViewModel) is about to be rendered in the UI - thereby allowing subscribers to optionally `org.apache.isis.applib.events.ui.TitleUiEvent#setTitle(String)` change) the title that is used.
+| Influences whether an ``org.apache.isis.applib.events.ui.TitleUiEvent`` should be published (on the internal ``org.apache.isis.applib.services.eventbus.EventBusService``) whenever a view model (annotated with @ViewModel) is about to be rendered in the UI - thereby allowing subscribers to optionally ``org.apache.isis.applib.events.ui.TitleUiEvent#setTitle(String)`` change) the title that is used.
-The algorithm for determining whether (and what type of) an event is sent depends on the value of the `org.apache.isis.applib.annotation.ViewModelLayout#titleUiEvent()` @ViewModelLayout(titleEvent=...)} for the domain object in question:
+The algorithm for determining whether (and what type of) an event is sent depends on the value of the ``org.apache.isis.applib.annotation.ViewModelLayout#titleUiEvent()`` @ViewModelLayout(titleEvent=...)} for the domain object in question:
* If set to some subtype of TitleUiEvent.Noop, then _no_ event is sent.
* If set to some subtype of TitleUiEvent.Default, then an event is sent _if and only if_ this configuration setting is set.
@@ -417,6 +417,6 @@ The algorithm for determining whether (and what type of) an event is sent depend
view-model.validation. +
semantic-checking.enable
|
-| Whether to check for inconsistencies between the usage of `org.apache.isis.applib.annotation.DomainObject`, `org.apache.isis.applib.annotation.ViewModel`, `org.apache.isis.applib.annotation.DomainObjectLayout` and `org.apache.isis.applib.annotation.ViewModelLayout`.
+| Whether to check for inconsistencies between the usage of ``org.apache.isis.applib.annotation.DomainObject``, ``org.apache.isis.applib.annotation.ViewModel``, ``org.apache.isis.applib.annotation.DomainObjectLayout`` and ``org.apache.isis.applib.annotation.ViewModelLayout``.
diff --git a/core/config/src/main/adoc/modules/config/examples/generated/isis.core.meta-model.introspector.adoc b/core/config/src/main/adoc/modules/config/examples/generated/isis.core.meta-model.introspector.adoc
index 8773d2e..d63ed7f 100644
--- a/core/config/src/main/adoc/modules/config/examples/generated/isis.core.meta-model.introspector.adoc
+++ b/core/config/src/main/adoc/modules/config/examples/generated/isis.core.meta-model.introspector.adoc
@@ -4,7 +4,7 @@ lock-after-full-introspection
| true
| If true, then no new specifications will be allowed to be loaded once introspection has been complete.
-Only applies if the introspector is configured to perform full introspection up-front (either because of `IntrospectionMode#FULL` or `IntrospectionMode#LAZY_UNLESS_PRODUCTION` when in production); otherwise is ignored.
+Only applies if the introspector is configured to perform full introspection up-front (either because of ``IntrospectionMode#FULL`` or ``IntrospectionMode#LAZY_UNLESS_PRODUCTION`` when in production); otherwise is ignored.
| isis.core.meta-model. +
@@ -12,7 +12,7 @@ introspector.mode
|
| Whether all known types should be fully introspected as part of the bootstrapping, or should only be partially introspected initially.
-Leaving this as lazy means that there's a chance that metamodel validation errors will not be discovered during bootstrap. That said, metamodel validation is still run incrementally for any classes introspected lazily after initial bootstrapping (unless `#isValidateIncrementally()` is disabled.
+Leaving this as lazy means that there's a chance that metamodel validation errors will not be discovered during bootstrap. That said, metamodel validation is still run incrementally for any classes introspected lazily after initial bootstrapping (unless ``#isValidateIncrementally()`` is disabled.
| isis.core.meta-model. +
@@ -29,6 +29,6 @@ validate-incrementally
This does _not_ apply if the introspector is configured to perform full introspection up-front AND when the metamodel is locked after initial bootstrapping (because in that case the lock check will simply prevent any new specs from being loaded). But it will apply otherwise.
-In particular, this setting _can_ still apply even if the introspection mode is set to full, because that in itself does not preclude some code from attempting to load some previously unknown type. For example, a fixture script could attempt to invoke an action on some new type using the `org.apache.isis.applib.services.wrapper.WrapperFactory` - this will cause introspection of that new type to be performed.
+In particular, this setting _can_ still apply even if the introspection mode is set to full, because that in itself does not preclude some code from attempting to load some previously unknown type. For example, a fixture script could attempt to invoke an action on some new type using the ``org.apache.isis.applib.services.wrapper.WrapperFactory`` - this will cause introspection of that new type to be performed.
diff --git a/core/config/src/main/adoc/modules/config/examples/generated/isis.core.meta-model.validator.adoc b/core/config/src/main/adoc/modules/config/examples/generated/isis.core.meta-model.validator.adoc
index 8943250..85940d8 100644
--- a/core/config/src/main/adoc/modules/config/examples/generated/isis.core.meta-model.validator.adoc
+++ b/core/config/src/main/adoc/modules/config/examples/generated/isis.core.meta-model.validator.adoc
@@ -25,25 +25,25 @@ validator.check-module-extent
validator. +
ensure-unique-object-types
| true
-| Whether to ensure that the object type of all objects (which can be set either explicitly using `DomainObject#objectType()` or `DomainService#objectType()`, or can be inferred implicitly using a variety of mechanisms) must be unique with respect to all other object types.
+| Whether to ensure that the object type of all objects (which can be set either explicitly using ``DomainObject#objectType()`` or ``DomainService#objectType()``, or can be inferred implicitly using a variety of mechanisms) must be unique with respect to all other object types.
-It is _highly advisable_ to leave this set as enabled (the default), and to also use explicit types (see `#isExplicitObjectType()`.
+It is _highly advisable_ to leave this set as enabled (the default), and to also use explicit types (see ``#isExplicitObjectType()``.
| isis.core.meta-model. +
validator. +
explicit-object-type
|
-| Whether to ensure that the object type of all objects must be specified explicitly, using either `DomainObject#objectType()` or `DomainService#objectType()`.
+| Whether to ensure that the object type of all objects must be specified explicitly, using either ``DomainObject#objectType()`` or ``DomainService#objectType()``.
-It is _highly advisable_ to leave this set as enabled (the default). These object types should also (of course) be unique - that can be checked by setting the `#isEnsureUniqueObjectTypes()` config property.
+It is _highly advisable_ to leave this set as enabled (the default). These object types should also (of course) be unique - that can be checked by setting the ``#isEnsureUniqueObjectTypes()`` config property.
| isis.core.meta-model. +
validator.jaxb-view-model. +
date-time-type-adapter
| true
-| If set, then ensures that for all properties of JAXB-style view models where the property's type is a date or time, then that property has been correctly annotated with @`javax.xml.bind.annotation.adapters.XmlJavaTypeAdapter` (so that the property's value can be converted into a serializable form).
+| If set, then ensures that for all properties of JAXB-style view models where the property's type is a date or time, then that property has been correctly annotated with @``javax.xml.bind.annotation.adapters.XmlJavaTypeAdapter`` (so that the property's value can be converted into a serializable form).
| isis.core.meta-model. +
@@ -71,7 +71,7 @@ not-inner-class
validator.jaxb-view-model. +
reference-type-adapter
| true
-| If set, then ensures that for all properties of JAXB-style view models where the property's type is an entity, then that entity's type has been correctly annotated with @`javax.xml.bind.annotation.adapters.XmlJavaTypeAdapter` (so that the property's value can be converted into a serializable form).
+| If set, then ensures that for all properties of JAXB-style view models where the property's type is an entity, then that entity's type has been correctly annotated with @``javax.xml.bind.annotation.adapters.XmlJavaTypeAdapter`` (so that the property's value can be converted into a serializable form).
| isis.core.meta-model. +
diff --git a/core/config/src/main/adoc/modules/config/examples/generated/isis.core.runtime-services.adoc b/core/config/src/main/adoc/modules/config/examples/generated/isis.core.runtime-services.adoc
index 88d149b..647226b 100644
--- a/core/config/src/main/adoc/modules/config/examples/generated/isis.core.runtime-services.adoc
+++ b/core/config/src/main/adoc/modules/config/examples/generated/isis.core.runtime-services.adoc
@@ -1,7 +1,7 @@
| isis.core.runtime-services. +
application-features.init
|
-| Whether the `org.apache.isis.applib.services.appfeat.ApplicationFeatureRepository` (or the default implementation of that service, at least) should compute the set of `ApplicationFeature` that describe the metamodel eagerly, or lazily.
+| Whether the ``org.apache.isis.applib.services.appfeat.ApplicationFeatureRepository`` (or the default implementation of that service, at least) should compute the set of `ApplicationFeature` that describe the metamodel eagerly, or lazily.
| isis.core.runtime-services. +
@@ -35,7 +35,7 @@ email.sender.address
If the username is not specified, is also used as the username to connect to the SMTP service.
-This configuration property is mandatory (for the default implementation of the `org.apache.isis.applib.services.email.EmailService`, at least).
+This configuration property is mandatory (for the default implementation of the ``org.apache.isis.applib.services.email.EmailService``, at least).
| isis.core.runtime-services. +
@@ -51,7 +51,7 @@ email.sender.password
|
| Specifies the password (corresponding to the username to connect to the SMTP service.
-This configuration property is mandatory (for the default implementation of the `org.apache.isis.applib.services.email.EmailService`, at least).
+This configuration property is mandatory (for the default implementation of the ``org.apache.isis.applib.services.email.EmailService``, at least).
| isis.core.runtime-services. +
@@ -91,7 +91,7 @@ email.tls.enabled
exception-recognizer.jdo. +
disable
|
-| Whether the `org.apache.isis.applib.services.exceprecog.ExceptionRecognizer` implementation for JDO/DataNucleus object store - which attempts to sanitize any exceptions arising from that object store - should be disabled (meaning that exceptions will potentially propagate as more serious to the end user).
+| Whether the ``org.apache.isis.applib.services.exceprecog.ExceptionRecognizer`` implementation for JDO/DataNucleus object store - which attempts to sanitize any exceptions arising from that object store - should be disabled (meaning that exceptions will potentially propagate as more serious to the end user).
| isis.core.runtime-services. +
diff --git a/core/config/src/main/adoc/modules/config/examples/generated/isis.core.runtime.adoc b/core/config/src/main/adoc/modules/config/examples/generated/isis.core.runtime.adoc
index 7eaf226..1354dd9 100644
--- a/core/config/src/main/adoc/modules/config/examples/generated/isis.core.runtime.adoc
+++ b/core/config/src/main/adoc/modules/config/examples/generated/isis.core.runtime.adoc
@@ -1,6 +1,6 @@
| isis.core.runtime.locale
|
-| If set, then overrides the application's `Locale#getDefault()`
+| If set, then overrides the application's ``Locale#getDefault()``
| isis.core.runtime.timezone
diff --git a/core/config/src/main/adoc/modules/config/examples/generated/isis.persistence.jdo-datanucleus.impl.adoc b/core/config/src/main/adoc/modules/config/examples/generated/isis.persistence.jdo-datanucleus.impl.adoc
index 2ffc3c0..1cbf264 100644
--- a/core/config/src/main/adoc/modules/config/examples/generated/isis.persistence.jdo-datanucleus.impl.adoc
+++ b/core/config/src/main/adoc/modules/config/examples/generated/isis.persistence.jdo-datanucleus.impl.adoc
@@ -43,7 +43,7 @@ Can be used to interface with external caching products. Use "none" to turn off
See also Cache docs for JDO, and for JPA
-@implNote - this config property isn't used by the framework, but is provided as a convenience for IDE autocomplete.
+NOTE: this config property isn't used by the framework, but is provided as a convenience for IDE autocomplete.
| isis.persistence. +
@@ -57,7 +57,7 @@ For RBDMS, it must be a JNDI name that points to a javax.sql.DataSource object.
See also `additional-spring-configuration-metadata.json` (PascalCasing instead of kebab-casing).
-@implNote - this config property isn't used by the framework, but is provided as a convenience for IDE autocomplete.
+NOTE: this config property isn't used by the framework, but is provided as a convenience for IDE autocomplete.
| isis.persistence. +
@@ -71,7 +71,7 @@ For RBDMS, it must be a JNDI name that points to a javax.sql.DataSource object.
See also `additional-spring-configuration-metadata.json` (PascalCasing instead of kebab-casing).
-@implNote - this config property isn't used by the framework, but is provided as a convenience for IDE autocomplete.
+NOTE: this config property isn't used by the framework, but is provided as a convenience for IDE autocomplete.
| isis.persistence. +
@@ -83,7 +83,7 @@ connection-password-decrypter
See also `additional-spring-configuration-metadata.json` (camelCasing instead of kebab-casing).
-@implNote - this config property isn't used by the framework, but is provided as a convenience for IDE autocomplete.
+NOTE: this config property isn't used by the framework, but is provided as a convenience for IDE autocomplete.
| isis.persistence. +
@@ -122,7 +122,7 @@ Defaults to true, which is the opposite of DataNucleus' own default. (The reason
See also `additional-spring-configuration-metadata.json` (camelCasing instead of kebab-casing).
-@implNote - this config property isn't used by the framework, but is provided as a convenience for IDE autocomplete.
+NOTE: this config property isn't used by the framework, but is provided as a convenience for IDE autocomplete.
| isis.persistence. +
@@ -144,7 +144,7 @@ This should be set to `true` when running against an in-memory database, but set
See also `additional-spring-configuration-metadata.json` (camelCasing instead of kebab-casing).
-@implNote - this config property isn't used by the core framework, but is used by one the flyway extension.
+NOTE: this config property isn't used by the core framework, but is used by one the flyway extension.
| isis.persistence. +
@@ -156,7 +156,7 @@ auto-create-database
See also `additional-spring-configuration-metadata.json` (camelCasing instead of kebab-casing).
-@implNote - this config property isn't used by the framework, but is provided as a convenience for IDE autocomplete.
+NOTE: this config property isn't used by the framework, but is provided as a convenience for IDE autocomplete.
| isis.persistence. +
@@ -180,7 +180,7 @@ validate-all
| true
| See also `additional-spring-configuration-metadata.json` (camelCasing instead of kebab-casing).
-@implNote - this config property isn't used by the framework, but is provided as a convenience for IDE autocomplete.
+NOTE: this config property isn't used by the framework, but is provided as a convenience for IDE autocomplete.
| isis.persistence. +
@@ -214,7 +214,7 @@ If running under JavaSE the default is RESOURCE_LOCAL, and if running under Java
See also `additional-spring-configuration-metadata.json` (camelCasing instead of kebab-casing).
-@implNote - this config property isn't used by the framework, but is provided as a convenience for IDE autocomplete.
+NOTE: this config property isn't used by the framework, but is provided as a convenience for IDE autocomplete.
| isis.persistence. +
@@ -259,7 +259,7 @@ connection-driver-name
See also `additional-spring-configuration-metadata.json` (PascalCasing instead of kebab-casing).
-@implNote - this config property isn't used by the framework, but provided as a convenience for IDE autocomplete (and is mandatory if using JDO Datanucleus).
+NOTE: this config property isn't used by the framework, but provided as a convenience for IDE autocomplete (and is mandatory if using JDO Datanucleus).
| isis.persistence. +
@@ -271,7 +271,7 @@ connection-password
See also `additional-spring-configuration-metadata.json` (PascalCasing instead of kebab-casing).
-@implNote - this config property isn't used by the framework, but provided as a convenience for IDE autocomplete. It is not necessarily mandatory, some databases accept an empty password.
+NOTE: this config property isn't used by the framework, but provided as a convenience for IDE autocomplete. It is not necessarily mandatory, some databases accept an empty password.
| isis.persistence. +
@@ -282,7 +282,7 @@ jdo.option.connection-url
See also `additional-spring-configuration-metadata.json` (PascalCasing instead of kebab-casing).
-@implNote - some extensions (H2Console, MsqlDbManager) peek at this URL to determine if they should be enabled. Note that it is also mandatory if using JDO Datanucleus.
+NOTE: some extensions (H2Console, MsqlDbManager) peek at this URL to determine if they should be enabled. Note that it is also mandatory if using JDO Datanucleus.
| isis.persistence. +
@@ -294,7 +294,7 @@ connection-user-name
See also `additional-spring-configuration-metadata.json` (PascalCasing instead of kebab-casing).
-@implNote - this config property isn't used by the framework, but provided as a convenience for IDE autocomplete (and is mandatory if using JDO Datanucleus).
+NOTE: this config property isn't used by the framework, but provided as a convenience for IDE autocomplete (and is mandatory if using JDO Datanucleus).
| isis.persistence. +
@@ -306,6 +306,6 @@ class
JDOPersistenceManagerFactory
| See also `additional-spring-configuration-metadata.json` (camelCasing instead of kebab-casing).
-@implNote - changing this property from its default is used to enable the flyway extension (in combination with `Datanucleus.Schema#isAutoCreateAll()`
+NOTE: changing this property from its default is used to enable the flyway extension (in combination with ``Datanucleus.Schema#isAutoCreateAll()``
diff --git a/core/config/src/main/adoc/modules/config/examples/generated/isis.viewer.restfulobjects.adoc b/core/config/src/main/adoc/modules/config/examples/generated/isis.viewer.restfulobjects.adoc
index abbc31b..96fc48b 100644
--- a/core/config/src/main/adoc/modules/config/examples/generated/isis.viewer.restfulobjects.adoc
+++ b/core/config/src/main/adoc/modules/config/examples/generated/isis.viewer.restfulobjects.adoc
@@ -1,7 +1,7 @@
| isis.viewer.restfulobjects. +
base-uri
|
-| If left unset (the default), then the RO viewer will use the `javax.ws.rs.core.UriInfo` injected using @link javax.ws.rs.core.Context}) to figure out the base Uri (used to render `href`s).
+| If left unset (the default), then the RO viewer will use the ``javax.ws.rs.core.UriInfo`` (injected using ``javax.ws.rs.core.Context``) to figure out the base Uri (used to render `href`s).
This will be correct much of the time, but will almost certainly be wrong if there is a reverse proxy.
diff --git a/core/config/src/main/adoc/modules/config/examples/generated/isis.viewer.wicket.adoc b/core/config/src/main/adoc/modules/config/examples/generated/isis.viewer.wicket.adoc
index d9c0f64..bda2ba7 100644
--- a/core/config/src/main/adoc/modules/config/examples/generated/isis.viewer.wicket.adoc
+++ b/core/config/src/main/adoc/modules/config/examples/generated/isis.viewer.wicket.adoc
@@ -8,7 +8,7 @@ ajax-debug-mode
| org.apache.isis.viewer. +
wicket.viewer.wicketapp. +
IsisWicketApplication
-| Specifies the subclass of < code>org.apache.isis.viewer.wicket.viewer.wicketapp.IsisWicketApplication that is used to bootstrap Wicket.
+| Specifies the subclass of `org.apache.isis.viewer.wicket.viewer.wicketapp.IsisWicketApplication` that is used to bootstrap Wicket.
There is usually very little reason to change this from its default.
@@ -30,7 +30,9 @@ This is rendered on the header panel. An image with a size of 160x40 works well.
| isis.viewer.wicket. +
application.brand-logo-signin
|
-| Either the location of the image file (relative to the class-path resource root), or an absolute URL. This is rendered on the sign-in page. An image with a size of 400x40 works well. If not specified, the `Application#name` is used instead.
+| Either the location of the image file (relative to the class-path resource root), or an absolute URL.
+
+This is rendered on the sign-in page. An image with a size of 400x40 works well. If not specified, the application name is used instead.
| isis.viewer.wicket. +
@@ -135,7 +137,11 @@ The default behaviour is to honour the original destination requested.
| isis.viewer.wicket.credit
|
-| IntelliJ unfortunately does not provide IDE completion for lists of classes; YMMV. For further discussion, see for example this stackoverflow question: https://stackoverflow.com/questions/41417933/spring-configuration-properties-metadata-json-for-nested-list-of-objects and this wiki page: https://github.com/spring-projects/spring-boot/wiki/IDE-binding-features#simple-pojo and
+| List of organisations or individuals to give credit to, shown as links and icons in the footer. A maximum of 3 credits can be specified.
+
+IntelliJ unfortunately does not provide IDE completion for lists of classes; YMMV.
+
+NOTE: For further discussion, see for example https://stackoverflow.com/questions/41417933/spring-configuration-properties-metadata-json-for-nested-list-of-objects[this stackoverflow question] and https://github.com/spring-projects/spring-boot/wiki/IDE-binding-features#simple-pojo[this wiki page].
| isis.viewer.wicket. +
@@ -143,7 +149,7 @@ date-pattern
| dd-MM-yyyy
| The pattern used for rendering and parsing dates.
-Each Date scalar panel will use \{#getDatePattern()} or \{@linkplain #getDateTimePattern()} depending on its date type. In the case of panels with a date picker, the pattern will be dynamically adjusted so that it can be used by the https://github.com/Eonasdan/bootstrap-datetimepicker[Bootstrap Datetime Picker] component (which uses http://momentjs.com/docs/#/parsing/string-format/[Moment.js formats], rather than those of regular Java code).
+Each Date scalar panel will use ``#getDatePattern()`` or ``#getDateTimePattern()`` depending on its date type. In the case of panels with a date picker, the pattern will be dynamically adjusted so that it can be used by the https://github.com/Eonasdan/bootstrap-datetimepicker[Bootstrap Datetime Picker] component (which uses http://momentjs.com/docs/#/parsing/string-format/[Moment.js formats], rather than those of regular Java code).
| isis.viewer.wicket. +
@@ -167,13 +173,13 @@ date-time-pattern
| dd-MM-yyyy HH:mm
| The pattern used for rendering and parsing date/times.
-Each Date scalar panel will use `Wicket#getDatePattern()` or `Wicket#getDateTimePattern()` depending on its date type. In the case of panels with a date time picker, the pattern will be dynamically adjusted so that it can be used by the https://github.com/Eonasdan/bootstrap-datetimepicker[Bootstrap Datetime Picker] component (which uses http://momentjs.com/docs/#/parsing/string-format/[Moment.js formats], rather than those of regular Java code).
+Each Date scalar panel will use ``#getDatePattern()`` or ``#getDateTimePattern()`` depending on its date type. In the case of panels with a date time picker, the pattern will be dynamically adjusted so that it can be used by the https://github.com/Eonasdan/bootstrap-datetimepicker[Bootstrap Datetime Picker] component (which uses http://momentjs.com/docs/#/parsing/string-format/[Moment.js formats], rather than those of regular Java code).
| isis.viewer.wicket. +
development-utilities.enable
|
-| Determines whether debug bar and other stuff influenced by `org.apache.wicket.settings.DebugSettings#isDevelopmentUtilitiesEnabled()` is enabled or not.
+| Determines whether debug bar and other stuff influenced by `DebugSettings#isDevelopmentUtilitiesEnabled()` is enabled or not.
By default, depends on the mode (prototyping = enabled, server = disabled). This property acts as an override.
@@ -183,7 +189,7 @@ dialog-mode
|
| Whether the dialog mode rendered when invoking actions on domain objects should be to use the sidebar (the default) or to use a modal dialog.
-This can be overridden on a case-by-case basis using `ActionLayout#promptStyle()`.
+This can be overridden on a case-by-case basis using ``ActionLayout#promptStyle()``.
| isis.viewer.wicket. +
@@ -191,7 +197,7 @@ dialog-mode-for-menu
|
| Whether the dialog mode rendered when invoking actions on domain services (that is, menus) should be to use a modal dialog (the default) or to use the sidebar panel.
-This can be overridden on a case-by-case basis using `ActionLayout#promptStyle()`.
+This can be overridden on a case-by-case basis using ``ActionLayout#promptStyle()``.
| isis.viewer.wicket. +
@@ -217,7 +223,7 @@ standalone-tables
| isis.viewer.wicket. +
max-title-length-in-tables
| 12
-| The maximum number of characters to use to render the title of a domain object (alongside the icon) in any table, if not otherwise overridden by either `#getMaxTitleLengthInParentedTables()` or `#getMaxTitleLengthInStandaloneTables()`.
+| The maximum number of characters to use to render the title of a domain object (alongside the icon) in any table, if not otherwise overridden by either ``#getMaxTitleLengthInParentedTables()`` or ``#getMaxTitleLengthInStandaloneTables()``.
If truncated, then the remainder of the title will be replaced with ellipses (...).
@@ -312,7 +318,7 @@ suppress-password-reset
|
| Whether to suppress the password reset link on the sign-in page.
-Although this is disabled by default (in other words the 'reset password' link is not suppressed), note that in addition the application must provide an implementation of the `org.apache.isis.applib.services.userreg.UserRegistrationService` as well as a configured `org.apache.isis.applib.services.userreg.EmailNotificationService` (same conditions as for the `#isSuppressSignUp()` sign-up link).
+Although this is disabled by default (in other words the 'reset password' link is not suppressed), note that in addition the application must provide an implementation of the ``org.apache.isis.applib.services.userreg.UserRegistrationService`` as well as a configured ``org.apache.isis.applib.services.userreg.EmailNotificationService`` (same conditions as for the ``#isSuppressSignUp()`` sign-up link).
| isis.viewer.wicket. +
@@ -320,7 +326,7 @@ suppress-sign-up
|
| Whether to suppress the sign-up link on the sign-in page.
-Although this is disabled by default (in other words the sign-up link is not suppressed), note that in addition the application must provide an implementation of the `org.apache.isis.applib.services.userreg.UserRegistrationService` as well as a configured `org.apache.isis.applib.services.userreg.EmailNotificationService` (same conditions as for the `#isSuppressPasswordReset()` password reset link).
+Although this is disabled by default (in other words the sign-up link is not suppressed), note that in addition the application must provide an implementation of the ``org.apache.isis.applib.services.userreg.UserRegistrationService`` as well as a configured ``org.apache.isis.applib.services.userreg.EmailNotificationService`` (same conditions as for the ``#isSuppressPasswordReset()`` password reset link).
| isis.viewer.wicket.themes. +
@@ -334,7 +340,7 @@ initial
| Flatly
| The initial theme to use.
-Expected to be in the list of `#getEnabled()` themes.
+Expected to be in the list of ``#getEnabled()`` themes.
| isis.viewer.wicket.themes. +
diff --git a/core/config/src/main/java/org/apache/isis/core/config/IsisConfiguration.java b/core/config/src/main/java/org/apache/isis/core/config/IsisConfiguration.java
index 9ad6b95..fc0cf62 100644
--- a/core/config/src/main/java/org/apache/isis/core/config/IsisConfiguration.java
+++ b/core/config/src/main/java/org/apache/isis/core/config/IsisConfiguration.java
@@ -2043,7 +2043,7 @@ public class IsisConfiguration {
* The pattern used for rendering and parsing dates.
*
* <p>
- * Each Date scalar panel will use {#getDatePattern()} or {@linkplain #getDateTimePattern()} depending on its
+ * Each Date scalar panel will use {@link #getDatePattern()} or {@link #getDateTimePattern()} depending on its
* date type. In the case of panels with a date picker, the pattern will be dynamically adjusted so that it can be
* used by the <a href="https://github.com/Eonasdan/bootstrap-datetimepicker">Bootstrap Datetime Picker</a>
* component (which uses <a href="http://momentjs.com/docs/#/parsing/string-format/">Moment.js formats</a>, rather
@@ -2056,7 +2056,7 @@ public class IsisConfiguration {
* The pattern used for rendering and parsing date/times.
*
* <p>
- * Each Date scalar panel will use {@link Wicket#getDatePattern()} or {@link Wicket#getDateTimePattern()}
+ * Each Date scalar panel will use {@link #getDatePattern()} or {@link #getDateTimePattern()}
* depending on its date type. In the case of panels with a date time picker, the pattern will be
* dynamically adjusted so that it can be
* used by the <a href="https://github.com/Eonasdan/bootstrap-datetimepicker">Bootstrap Datetime Picker</a>
@@ -2432,20 +2432,25 @@ public class IsisConfiguration {
}
/**
+ * List of organisations or individuals to give credit to, shown as links and icons in the footer.
+ * A maximum of 3 credits can be specified.
+ *
+ * <p>
* IntelliJ unfortunately does not provide IDE completion for lists of classes; YMMV.
+ * </p>
*
- * For further discussion, see for example this stackoverflow question:
- * https://stackoverflow.com/questions/41417933/spring-configuration-properties-metadata-json-for-nested-list-of-objects
- * and this wiki page: https://github.com/spring-projects/spring-boot/wiki/IDE-binding-features#simple-pojo and
- *
+ * <p>
+ * @implNote - For further discussion, see for example
+ * <a href="https://stackoverflow.com/questions/41417933/spring-configuration-properties-metadata-json-for-nested-list-of-objects">this stackoverflow question</a>
+ * and <a href="https://github.com/spring-projects/spring-boot/wiki/IDE-binding-features#simple-pojo">this wiki page</a>.
+ * </p>
*/
private List<Credit> credit = new ArrayList<>();
-
+
@Data
public static class Credit {
/**
* URL of an organisation or individual to give credit to, appearing as a link in the footer.
- * A maximum of 3 credits is supported.
*
* <p>
* For the credit to appear, the {@link #getUrl() url} must be provided along with either
@@ -2456,7 +2461,6 @@ public class IsisConfiguration {
private String url;
/**
* URL of an organisation or individual to give credit to, appearing as text in the footer.
- * A maximum of 3 credits is supported.
*
* <p>
* For the credit to appear, the {@link #getUrl() url} must be provided along with either
@@ -2466,7 +2470,6 @@ public class IsisConfiguration {
private String name;
/**
* Name of an image resource of an organisation or individual, appearing as an icon in the footer.
- * A maximum of 3 credits is supported.
*
* <p>
* For the credit to appear, the {@link #getUrl() url} must be provided along with either
diff --git a/scripts/generateConfigDocs.groovy b/scripts/generateConfigDocs.groovy
index 843166f..7f80ee2 100644
--- a/scripts/generateConfigDocs.groovy
+++ b/scripts/generateConfigDocs.groovy
@@ -262,7 +262,11 @@ static String toAsciidoc(String str) {
System.out.print(".");
str = str.replaceAll( /\{@link[ ]+?([^}]+?)[ ]+?([^}]+?)[ ]*?}/, '$2')
- str = str.replaceAll( /\{@link[ ]+?([^}]+?)[ ]*?}/, '`$1`')
+ str = str.replaceAll( /\{@link[ ]+?([^}]+?)[ ]*?}/, '``$1``')
+ str = str.replaceAll( /@apiNote -/, 'TIP:')
+ str = str.replaceAll( /@apiNote/, 'TIP:')
+ str = str.replaceAll( /@implNote -/, 'NOTE:')
+ str = str.replaceAll( /@implNote/, 'NOTE:')
File tf = File.createTempFile("input",".html")
tf.write(str) // write to the file