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/17 14:05:03 UTC
[isis] 05/05: ISIS-2062: cleans up the generated .adoc with some
regex before hand
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 e57b222cd1e5eba3b53523cea2c5f61787e7da88
Author: danhaywood <da...@haywood-associates.co.uk>
AuthorDate: Fri Jan 17 14:56:12 2020 +0100
ISIS-2062: cleans up the generated .adoc with some regex before hand
---
.../config/examples/generated/isis.applib.adoc | 134 ++++++++++-----------
.../isis.core.meta-model.introspector.adoc | 8 +-
.../examples/generated/isis.core.runtime.adoc | 2 +-
.../isis.persistence.jdo-datanucleus.impl.adoc | 2 +-
.../generated/isis.viewer.restfulobjects.adoc | 2 +-
.../examples/generated/isis.viewer.wicket.adoc | 8 +-
.../config/examples/generated/resteasy.adoc | 2 +-
scripts/generateConfigDocs.groovy | 2 +
8 files changed, 81 insertions(+), 79 deletions(-)
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 29c73b7..64201e0 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
@@ -23,7 +23,7 @@ domain-event.post-for-default
| isis.applib.annotation.action. +
explicit
|
-| Whether or not a public method needs to be annotated with @\{@link 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. +
@@ -53,12 +53,12 @@ domain-object-layout. +
css-class-ui-event. +
post-for-default
| true
-| Influences whether an \{@link org.apache.isis.applib.events.ui.CssClassUiEvent} should be published (on the internal \{@link org.apache.isis.applib.services.eventbus.EventBusService}) whenever a domain object is about to be rendered in the UI - thereby allowing subscribers to optionally \{@link org.apache.isis.applib.events.ui.CssClassUiEvent#setCssClass(String)} change) the CSS classes that are used.
+| Influences whether an 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 change) the CSS classes that are used.
-The algorithm for determining whether an event is sent depends on the value of the \{@link org.apache.isis.applib.annotation.DomainObjectLayout#cssClassUiEvent()} @DomainObjectLayout(cssClassEvent=...)} for the domain object in question.
+The algorithm for determining whether an event is sent depends on the value of the \{@link org.apache.isis.applib.annotation.DomainObjectLayout#cssClassUiEvent() @DomainObjectLayout(cssClassEvent=...)` for the domain object in question.
-* If set to some subtype of \{@link org.apache.isis.applib.events.ui.CssClassUiEvent.Noop CssClassUiEvent.Noop}, then _no_ event is sent.
-* If set to some subtype of \{@link org.apache.isis.applib.events.ui.CssClassUiEvent.Default CssClassUiEvent.Default}, then an event is sent _if and only if_ this configuration setting is set.
+* 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.
* If set to any other subtype, then an event _is_ sent.
@@ -67,12 +67,12 @@ domain-object-layout. +
icon-ui-event. +
post-for-default
| true
-| Influences whether an \{@link org.apache.isis.applib.events.ui.IconUiEvent} should be published (on the internal \{@link org.apache.isis.applib.services.eventbus.EventBusService}) whenever a domain object is about to be rendered in the UI - thereby allowing subscribers to optionally \{@link org.apache.isis.applib.events.ui.IconUiEvent#setIconName(String)} change) the icon that is used.
+| Influences whether an 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 change) the icon that is used.
-The algorithm for determining whether an event is sent depends on the value of the \{@link org.apache.isis.applib.annotation.DomainObjectLayout#iconUiEvent()} @DomainObjectLayout(iconEvent=...)} for the domain object in question.
+The algorithm for determining whether an event is sent depends on the value of the \{@link org.apache.isis.applib.annotation.DomainObjectLayout#iconUiEvent() @DomainObjectLayout(iconEvent=...)` for the domain object in question.
-* If set to some subtype of \{@link org.apache.isis.applib.events.ui.IconUiEvent.Noop IconUiEvent.Noop}, then _no_ event is sent.
-* If set to some subtype of \{@link org.apache.isis.applib.events.ui.IconUiEvent.Default IconUiEvent.Default}, then an event is sent _if and only if_ this configuration setting is set.
+* 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.
* If set to any other subtype, then an event _is_ sent.
@@ -81,14 +81,14 @@ domain-object-layout. +
layout-ui-event. +
post-for-default
| true
-| Influences whether an \{@link org.apache.isis.applib.events.ui.LayoutUiEvent} should be published (on the internal \{@link org.apache.isis.applib.services.eventbus.EventBusService}) whenever a domain object is about to be rendered in the UI - thereby allowing subscribers to optionally \{@link org.apache.isis.applib.events.ui.LayoutUiEvent#setLayout(String)} change) the layout that is used.
+| Influences whether an 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 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 an event is sent depends on the value of the \{@link org.apache.isis.applib.annotation.DomainObjectLayout#layoutUiEvent()} @DomainObjectLayout(layoutEvent=...)} for the domain object in question.
+The algorithm for determining whether an event is sent depends on the value of the \{@link org.apache.isis.applib.annotation.DomainObjectLayout#layoutUiEvent() @DomainObjectLayout(layoutEvent=...)` for the domain object in question.
-* If set to some subtype of \{@link org.apache.isis.applib.events.ui.LayoutUiEvent.Noop LayoutUiEvent.Noop}, then _no_ event is sent.
-* If set to some subtype of \{@link org.apache.isis.applib.events.ui.LayoutUiEvent.Default LayoutUiEvent.Default}, then an event is sent _if and only if_ this configuration setting is set.
+* 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.
* If set to any other subtype, then an event _is_ sent.
@@ -102,21 +102,21 @@ domain-object-layout. +
title-ui-event. +
post-for-default
| true
-| Influences whether an \{@link org.apache.isis.applib.events.ui.TitleUiEvent} should be published (on the internal \{@link org.apache.isis.applib.services.eventbus.EventBusService}) whenever a domain object is about to be rendered in the UI - thereby allowing subscribers to optionally \{@link org.apache.isis.applib.events.ui.TitleUiEvent#setTitle(String)} change) the title that is used.
+| Influences whether an 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 change) the title that is used.
-The algorithm for determining whether an event is sent depends on the value of the \{@link org.apache.isis.applib.annotation.DomainObjectLayout#titleUiEvent()} @DomainObjectLayout(titleEvent=...)} for the domain object in question.
+The algorithm for determining whether an event is sent depends on the value of the \{@link org.apache.isis.applib.annotation.DomainObjectLayout#titleUiEvent() @DomainObjectLayout(titleEvent=...)` for the domain object in question.
-* If set to some subtype of \{@link org.apache.isis.applib.events.ui.TitleUiEvent.Noop TitleUiEvent.Noop}, then _no_ event is sent.
-* If set to some subtype of \{@link org.apache.isis.applib.events.ui.TitleUiEvent.Default TitleUiEvent.Default}, then an event is sent _if and only if_ this configuration setting is set.
+* 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.
* If set to any other subtype, then an event _is_ sent.
| 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 \{@link 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
-This setting can be overridden on a case-by-case basis using \{@link DomainObject#getAuditing() DomainObject#getAuditing()}
+This setting can be overridden on a case-by-case basis using \{@link DomainObject#getAuditing() DomainObject#getAuditing()
Note: this applies only to domain entities, not view models.
@@ -126,12 +126,12 @@ domain-object. +
created-lifecycle-event. +
post-for-default
| true
-| Influences whether an \{@link org.apache.isis.applib.events.lifecycle.ObjectCreatedEvent} should be published (on the internal \{@link org.apache.isis.applib.services.eventbus.EventBusService}) whenever a domain object has been created using \{@link org.apache.isis.applib.services.factory.FactoryService}..
+| Influences whether an should be published (on the internal \{@link org.apache.isis.applib.services.eventbus.EventBusService) whenever a domain object has been created using
-The algorithm for determining whether an event is sent depends on the value of the \{@link org.apache.isis.applib.annotation.DomainObject#createdLifecycleEvent() @DomainObject(createdLifecycleEvent=...)} for the domain object in question.
+The algorithm for determining whether an event is sent depends on the value of the \{@link org.apache.isis.applib.annotation.DomainObject#createdLifecycleEvent() @DomainObject(createdLifecycleEvent=...) for the domain object in question.
-* If set to some subtype of \{@link org.apache.isis.applib.events.lifecycle.ObjectCreatedEvent.Noop ObjectCreatedEvent.Noop}, then _no_ event is sent.
-* If set to some subtype of \{@link org.apache.isis.applib.events.lifecycle.ObjectCreatedEvent.Default ObjectCreatedEvent.Default}, then an event is sent _if and only if_ this configuration setting is set.
+* If set to some subtype of ObjectCreatedEvent.Noop, then _no_ event is sent.
+* If set to some subtype of ObjectCreatedEvent.Default, then an event is sent _if and only if_ this configuration setting is set.
* If set to any other subtype, then an event _is_ sent.
@@ -140,7 +140,7 @@ domain-object.editing
|
| The default for whether the properties of domain objects can be edited, or whether instead they can be modified only using actions (or programmatically as a side-effect of actions on other objects).
-This setting can be overridden on a case-by-case basis using \{@link DomainObject#getEditing() DomainObject#getEditing()}
+This setting can be overridden on a case-by-case basis using DomainObject#getEditing()
| isis.applib.annotation. +
@@ -148,12 +148,12 @@ domain-object. +
loaded-lifecycle-event. +
post-for-default
| true
-| Influences whether an \{@link org.apache.isis.applib.events.lifecycle.ObjectLoadedEvent} should be published (on the internal \{@link org.apache.isis.applib.services.eventbus.EventBusService}) whenever a domain _entity_ has been loaded from the persistence store.
+| Influences whether an should be published (on the internal \{@link org.apache.isis.applib.services.eventbus.EventBusService) whenever a domain _entity_ has been loaded from the persistence store.
-The algorithm for determining whether an event is sent depends on the value of the \{@link org.apache.isis.applib.annotation.DomainObject#loadedLifecycleEvent() @DomainObject(loadedLifecycleEvent=...)} for the domain object in question.
+The algorithm for determining whether an event is sent depends on the value of the @DomainObject(loadedLifecycleEvent=...) for the domain object in question.
-* If set to some subtype of \{@link org.apache.isis.applib.events.lifecycle.ObjectLoadedEvent.Noop ObjectLoadedEvent.Noop}, then _no_ event is sent.
-* If set to some subtype of \{@link org.apache.isis.applib.events.lifecycle.ObjectLoadedEvent.Default ObjectCreatedEvent.Default}, then an event is sent _if and only if_ this configuration setting is set.
+* If set to some subtype of ObjectLoadedEvent.Noop, then _no_ event is sent.
+* If set to some subtype of ObjectCreatedEvent.Default, then an event is sent _if and only if_ this configuration setting is set.
* If set to any other subtype, then an event _is_ sent.
Note: this applies only to domain entities, not to view models.
@@ -164,12 +164,12 @@ domain-object. +
persisted-lifecycle-event. +
post-for-default
| true
-| Influences whether an \{@link org.apache.isis.applib.events.lifecycle.ObjectPersistedEvent} should be published (on the internal \{@link 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 should be published (on the internal \{@link 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 an event is sent depends on the value of the \{@link org.apache.isis.applib.annotation.DomainObject#persistedLifecycleEvent() @DomainObject(persistedLifecycleEvent=...)} for the domain object in question.
+The algorithm for determining whether an event is sent depends on the value of the @DomainObject(persistedLifecycleEvent=...) for the domain object in question.
-* If set to some subtype of \{@link org.apache.isis.applib.events.lifecycle.ObjectPersistedEvent.Noop ObjectPersistedEvent.Noop}, then _no_ event is sent.
-* If set to some subtype of \{@link org.apache.isis.applib.events.lifecycle.ObjectPersistedEvent.Default ObjectCreatedEvent.Default}, then an event is sent _if and only if_ this configuration setting is set.
+* If set to some subtype of ObjectPersistedEvent.Noop, then _no_ event is sent.
+* If set to some subtype of ObjectCreatedEvent.Default, then an event is sent _if and only if_ this configuration setting is set.
* If set to any other subtype, then an event _is_ sent.
Note: this applies only to domain entities, not to view models.
@@ -180,12 +180,12 @@ domain-object. +
persisting-lifecycle-event. +
post-for-default
| true
-| Influences whether an \{@link org.apache.isis.applib.events.lifecycle.ObjectPersistingEvent} should be published (on the internal \{@link 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 should be published (on the internal \{@link 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 an event is sent depends on the value of the \{@link org.apache.isis.applib.annotation.DomainObject#persistingLifecycleEvent() @DomainObject(persistingLifecycleEvent=...)} for the domain object in question.
+The algorithm for determining whether an event is sent depends on the value of the @DomainObject(persistingLifecycleEvent=...) for the domain object in question.
-* If set to some subtype of \{@link org.apache.isis.applib.events.lifecycle.ObjectPersistingEvent.Noop ObjectPersistingEvent.Noop}, then _no_ event is sent.
-* If set to some subtype of \{@link org.apache.isis.applib.events.lifecycle.ObjectPersistingEvent.Default ObjectCreatedEvent.Default}, then an event is sent _if and only if_ this configuration setting is set.
+* If set to some subtype of ObjectPersistingEvent.Noop, then _no_ event is sent.
+* If set to some subtype of ObjectCreatedEvent.Default, then an event is sent _if and only if_ this configuration setting is set.
* If set to any other subtype, then an event _is_ sent.
Note: this applies only to domain entities, not to view models.
@@ -194,11 +194,11 @@ Note: this applies only to domain entities, not to view models.
| isis.applib.annotation. +
domain-object.publishing
|
-| The default for whether the properties of domain objects can be edited, or whether instead changed objects should be sent through to the \{@link org.apache.isis.applib.services.publish.PublisherService} for publishing.
+| The default for whether the properties of domain objects can be edited, or whether instead changed objects should be sent through to the for publishing.
-The service's \{@link org.apache.isis.applib.services.publish.PublisherService#publish(PublishedObjects) publish} method is called only once per transaction, with \{@link PublishedObjects} collecting details of all changed domain objects.
+The service's \{@link org.apache.isis.applib.services.publish.PublisherService#publish(PublishedObjects) publish method is called only once per transaction, with collecting details of all changed domain objects.
-This setting can be overridden on a case-by-case basis using \{@link DomainObject#getPublishing() DomainObject#getPublishing()}.
+This setting can be overridden on a case-by-case basis using \{@link DomainObject#getPublishing() DomainObject#getPublishing().
| isis.applib.annotation. +
@@ -206,12 +206,12 @@ domain-object. +
removing-lifecycle-event. +
post-for-default
| true
-| Influences whether an \{@link org.apache.isis.applib.events.lifecycle.ObjectRemovingEvent} should be published (on the internal \{@link 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 should be published (on the internal \{@link 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 an event is sent depends on the value of the \{@link org.apache.isis.applib.annotation.DomainObject#removingLifecycleEvent() @DomainObject(removingLifecycleEvent=...)} for the domain object in question.
+The algorithm for determining whether an event is sent depends on the value of the @DomainObject(removingLifecycleEvent=...) for the domain object in question.
-* If set to some subtype of \{@link org.apache.isis.applib.events.lifecycle.ObjectRemovingEvent.Noop ObjectRemovingEvent.Noop}, then _no_ event is sent.
-* If set to some subtype of \{@link org.apache.isis.applib.events.lifecycle.ObjectRemovingEvent.Default ObjectCreatedEvent.Default}, then an event is sent _if and only if_ this configuration setting is set.
+* If set to some subtype of ObjectRemovingEvent.Noop, then _no_ event is sent.
+* If set to some subtype of ObjectCreatedEvent.Default, then an event is sent _if and only if_ this configuration setting is set.
* If set to any other subtype, then an event _is_ sent.
Note: this applies only to domain entities, not to view models.
@@ -224,12 +224,12 @@ domain-object. +
updated-lifecycle-event. +
post-for-default
| true
-| Influences whether an \{@link org.apache.isis.applib.events.lifecycle.ObjectUpdatedEvent} should be published (on the internal \{@link org.apache.isis.applib.services.eventbus.EventBusService}) whenever a persistent domain _entity_ has been updated in the persistence store.
+| Influences whether an should be published (on the internal \{@link org.apache.isis.applib.services.eventbus.EventBusService) whenever a persistent domain _entity_ has been updated in the persistence store.
-The algorithm for determining whether an event is sent depends on the value of the \{@link org.apache.isis.applib.annotation.DomainObject#updatedLifecycleEvent() @DomainObject(updatedLifecycleEvent=...)} for the domain object in question.
+The algorithm for determining whether an event is sent depends on the value of the @DomainObject(updatedLifecycleEvent=...) for the domain object in question.
-* If set to some subtype of \{@link org.apache.isis.applib.events.lifecycle.ObjectUpdatedEvent.Noop ObjectUpdatedEvent.Noop}, then _no_ event is sent.
-* If set to some subtype of \{@link org.apache.isis.applib.events.lifecycle.ObjectUpdatedEvent.Default ObjectCreatedEvent.Default}, then an event is sent _if and only if_ this configuration setting is set.
+* If set to some subtype of ObjectUpdatedEvent.Noop, then _no_ event is sent.
+* If set to some subtype of ObjectCreatedEvent.Default, then an event is sent _if and only if_ this configuration setting is set.
* If set to any other subtype, then an event _is_ sent.
Note: this applies only to domain entities, not to view models.
@@ -240,12 +240,12 @@ domain-object. +
updating-lifecycle-event. +
post-for-default
| true
-| Influences whether an \{@link org.apache.isis.applib.events.lifecycle.ObjectUpdatingEvent} should be published (on the internal \{@link org.apache.isis.applib.services.eventbus.EventBusService}) whenever a persistent domain _entity_ is about to be updated in the persistence store.
+| Influences whether an should be published (on the internal \{@link 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 an event is sent depends on the value of the \{@link org.apache.isis.applib.annotation.DomainObject#updatingLifecycleEvent() @DomainObject(updatingLifecycleEvent=...)} for the domain object in question.
+The algorithm for determining whether an event is sent depends on the value of the @DomainObject(updatingLifecycleEvent=...) for the domain object in question.
-* If set to some subtype of \{@link org.apache.isis.applib.events.lifecycle.ObjectUpdatingEvent.Noop ObjectUpdatingEvent.Noop}, then _no_ event is sent.
-* If set to some subtype of \{@link org.apache.isis.applib.events.lifecycle.ObjectUpdatingEvent.Default ObjectCreatedEvent.Default}, then an event is sent _if and only if_ this configuration setting is set.
+* If set to some subtype of ObjectUpdatingEvent.Noop, then _no_ event is sent.
+* If set to some subtype of ObjectCreatedEvent.Default, then an event is sent _if and only if_ this configuration setting is set.
* If set to any other subtype, then an event _is_ sent.
Note: this applies only to domain entities, not to view models.
@@ -284,12 +284,12 @@ view-model-layout. +
css-class-ui-event. +
post-for-default
| true
-| Influences whether an \{@link org.apache.isis.applib.events.ui.CssClassUiEvent} should be published (on the internal \{@link org.apache.isis.applib.services.eventbus.EventBusService}) whenever a view model (annotated with \{@link org.apache.isis.applib.annotation.ViewModel @ViewModel}) is about to be rendered in the UI - thereby allowing subscribers to optionally \{@link org.apache.isis.applib.events.ui.CssClassUiEvent#setCssClass(String)} change) the CSS classes that are used.
+| Influences whether an 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 change) the CSS classes that are used.
-The algorithm for determining whether an event is sent depends on the value of the \{@link org.apache.isis.applib.annotation.ViewModelLayout#cssClassUiEvent()} @ViewModelLayout(cssClassEvent=...)} for the domain object in question.
+The algorithm for determining whether an event is sent depends on the value of the \{@link org.apache.isis.applib.annotation.ViewModelLayout#cssClassUiEvent() @ViewModelLayout(cssClassEvent=...)` for the domain object in question.
-* If set to some subtype of \{@link org.apache.isis.applib.events.ui.CssClassUiEvent.Noop CssClassUiEvent.Noop}, then _no_ event is sent.
-* If set to some subtype of \{@link org.apache.isis.applib.events.ui.CssClassUiEvent.Default CssClassUiEvent.Default}, then an event is sent _if and only if_ this configuration setting is set.
+* 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.
* If set to any other subtype, then an event _is_ sent.
@@ -298,12 +298,12 @@ view-model-layout. +
icon-ui-event. +
post-for-default
| true
-| Influences whether an \{@link org.apache.isis.applib.events.ui.IconUiEvent} should be published (on the internal \{@link org.apache.isis.applib.services.eventbus.EventBusService}) whenever a view model (annotated with \{@link org.apache.isis.applib.annotation.ViewModel @ViewModel}) is about to be rendered in the UI - thereby allowing subscribers to optionally \{@link org.apache.isis.applib.events.ui.IconUiEvent#setIconName(String)} change) the icon that is used.
+| Influences whether an 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 change) the icon that is used.
-The algorithm for determining whether an event is sent depends on the value of the \{@link org.apache.isis.applib.annotation.ViewModelLayout#iconUiEvent()} @ViewModelLayout(iconEvent=...)} for the domain object in question.
+The algorithm for determining whether an event is sent depends on the value of the \{@link org.apache.isis.applib.annotation.ViewModelLayout#iconUiEvent() @ViewModelLayout(iconEvent=...)` for the domain object in question.
-* If set to some subtype of \{@link org.apache.isis.applib.events.ui.IconUiEvent.Noop IconUiEvent.Noop}, then _no_ event is sent.
-* If set to some subtype of \{@link org.apache.isis.applib.events.ui.IconUiEvent.Default IconUiEvent.Default}, then an event is sent _if and only if_ this configuration setting is set.
+* 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.
* If set to any other subtype, then an event _is_ sent.
@@ -312,14 +312,14 @@ view-model-layout. +
layout-ui-event. +
post-for-default
| true
-| Influences whether an \{@link org.apache.isis.applib.events.ui.LayoutUiEvent} should be published (on the internal \{@link org.apache.isis.applib.services.eventbus.EventBusService}) whenever a view model (annotated with \{@link org.apache.isis.applib.annotation.ViewModel @ViewModel}) is about to be rendered in the UI - thereby allowing subscribers to optionally \{@link org.apache.isis.applib.events.ui.LayoutUiEvent#setLayout(String)} change) the layout that is used.
+| Influences whether an 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 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 an event is sent depends on the value of the \{@link org.apache.isis.applib.annotation.ViewModelLayout#layoutUiEvent()} @ViewModelLayout(layoutEvent=...)} for the domain object in question.
+The algorithm for determining whether an event is sent depends on the value of the \{@link org.apache.isis.applib.annotation.ViewModelLayout#layoutUiEvent() @ViewModelLayout(layoutEvent=...)` for the domain object in question.
-* If set to some subtype of \{@link org.apache.isis.applib.events.ui.LayoutUiEvent.Noop LayoutUiEvent.Noop}, then _no_ event is sent.
-* If set to some subtype of \{@link org.apache.isis.applib.events.ui.LayoutUiEvent.Default LayoutUiEvent.Default}, then an event is sent _if and only if_ this configuration setting is set.
+* 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.
* If set to any other subtype, then an event _is_ sent.
@@ -328,12 +328,12 @@ view-model-layout. +
title-ui-event. +
post-for-default
| true
-| Influences whether an \{@link org.apache.isis.applib.events.ui.TitleUiEvent} should be published (on the internal \{@link org.apache.isis.applib.services.eventbus.EventBusService}) whenever a view model (annotated with \{@link org.apache.isis.applib.annotation.ViewModel @ViewModel}) is about to be rendered in the UI - thereby allowing subscribers to optionally \{@link org.apache.isis.applib.events.ui.TitleUiEvent#setTitle(String)} change) the title that is used.
+| Influences whether an 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 change) the title that is used.
-The algorithm for determining whether an event is sent depends on the value of the \{@link org.apache.isis.applib.annotation.ViewModelLayout#titleUiEvent()} @ViewModelLayout(titleEvent=...)} for the domain object in question.
+The algorithm for determining whether an event is sent depends on the value of the \{@link org.apache.isis.applib.annotation.ViewModelLayout#titleUiEvent() @ViewModelLayout(titleEvent=...)` for the domain object in question.
-* If set to some subtype of \{@link org.apache.isis.applib.events.ui.TitleUiEvent.Noop TitleUiEvent.Noop}, then _no_ event is sent.
-* If set to some subtype of \{@link org.apache.isis.applib.events.ui.TitleUiEvent.Default TitleUiEvent.Default}, then an event is sent _if and only if_ this configuration setting is set.
+* 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.
* If set to any other subtype, then an event _is_ sent.
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 5482034..9534929 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 \{@link IntrospectionMode#FULL} or \{@link 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 or \{@link 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 \{@link #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. +
@@ -27,8 +27,8 @@ validate-incrementally
| true
| If true, then metamodel validation is performed after any new specification has been loaded (after the initial bootstrapping).
-This does _not_ apply if the introspector is configured to perform full introspection up-front AND when the metamodel is \{@link Core.MetaModel.Introspector#isLockAfterFullIntrospection() 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.
+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 \{@link Core.MetaModel.Introspector#getMode() introspection mode} is set to \{@link IntrospectionMode#FULL 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 \{@link 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.runtime.adoc b/core/config/src/main/adoc/modules/config/examples/generated/isis.core.runtime.adoc
index 1e42adf..845ccca 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
|
-| Set to override \{@link Locale#getDefault()}
+| Set to override `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 a06c42e..2ffc3c0 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
@@ -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 \{@link Datanucleus.Schema#isAutoCreateAll()}
+@implNote - 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 e6ad358..8d4dfa5 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 \{@link 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 injected using @link 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 9dd0777..19f4abd 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
@@ -27,7 +27,7 @@ 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 \{@link 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. +
@@ -62,7 +62,7 @@ menubars-layout-xml
| isis.viewer.wicket. +
application.name
| Apache Isis ™
-| Identifies the application on the sign-in page (unless a \{@link Application#brandLogoSignin} image is configured) and on top-left in the header (unless a \{@link Application#brandLogoHeader} image is configured).
+| Identifies the application on the sign-in page (unless a image is configured) and on top-left in the header (unless a \{@link Application#brandLogoHeader image is configured).
| isis.viewer.wicket. +
@@ -127,7 +127,7 @@ date-time-pattern
| dd-MM-yyyy HH:mm
| The pattern used for rendering and parsing date/times.
-Each Date scalar panel will use \{@link Wicket#getDatePattern()} or \{@link 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 or \{@link 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).
| isis.viewer.wicket. +
@@ -252,7 +252,7 @@ initial
| Flatly
| The initial theme to use.
-Expected to be in the list of \{@link #getEnabled()} themes.
+Expected to be in the list of `#getEnabled()` themes.
| isis.viewer.wicket.themes. +
diff --git a/core/config/src/main/adoc/modules/config/examples/generated/resteasy.adoc b/core/config/src/main/adoc/modules/config/examples/generated/resteasy.adoc
index c2d5177..615a658 100644
--- a/core/config/src/main/adoc/modules/config/examples/generated/resteasy.adoc
+++ b/core/config/src/main/adoc/modules/config/examples/generated/resteasy.adoc
@@ -13,7 +13,7 @@ registration
| resteasy.jaxrs.default-path
| /restful
-| Note that this is used rather than `resteasy.servlet.mapping.prefix` because there is _NO_ implementation of \{@link javax.ws.rs.core.Application}, so we rely on it being automatically created.
+| Note that this is used rather than `resteasy.servlet.mapping.prefix` because there is _NO_ implementation of `javax.ws.rs.core.Application`, so we rely on it being automatically created.
| resteasy.resteasy-settings
diff --git a/scripts/generateConfigDocs.groovy b/scripts/generateConfigDocs.groovy
index f21634c..257f59e 100644
--- a/scripts/generateConfigDocs.groovy
+++ b/scripts/generateConfigDocs.groovy
@@ -261,6 +261,8 @@ System.out.println("");
static String toAsciidoc(String str) {
System.out.print(".");
+ str = str.replaceAll( /\{@link[ ]+?(.+?)[ ]+(.+?)[ ]*?}/, '$2')
+ str = str.replaceAll( /\{@link[ ]+?(.+?)[ ]*?}/, '`$1`')
File tf = File.createTempFile("input",".html")
tf.write(str) // write to the file