You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@isis.apache.org by ah...@apache.org on 2020/12/13 03:38:17 UTC
[isis] 01/02: ISIS-2473: freezing all applib antora examples,
also add annotations package to be indexed (global document index)
This is an automated email from the ASF dual-hosted git repository.
ahuber pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/isis.git
commit d17511ca750d6b09952977a01f6a4817314af799
Author: Andi Huber <ah...@apache.org>
AuthorDate: Sun Dec 13 04:32:52 2020 +0100
ISIS-2473: freezing all applib antora examples, also add annotations
package to be indexed (global document index)
---
api/applib/src/main/adoc/modules/applib-ant/examples.sh | 6 ++++++
api/applib/src/main/adoc/modules/applib-classes/examples.sh | 6 ++++++
api/applib/src/main/adoc/modules/applib-svc/examples.sh | 2 +-
.../src/main/java/org/apache/isis/applib/annotation/Action.java | 1 +
.../main/java/org/apache/isis/applib/annotation/ActionLayout.java | 1 +
.../main/java/org/apache/isis/applib/annotation/BookmarkPolicy.java | 4 ++++
.../src/main/java/org/apache/isis/applib/annotation/Bounding.java | 2 ++
.../src/main/java/org/apache/isis/applib/annotation/Collection.java | 2 ++
.../java/org/apache/isis/applib/annotation/CollectionLayout.java | 2 ++
.../src/main/java/org/apache/isis/applib/annotation/Defaulted.java | 1 +
.../main/java/org/apache/isis/applib/annotation/DomainObject.java | 2 ++
.../java/org/apache/isis/applib/annotation/DomainObjectLayout.java | 3 +++
.../main/java/org/apache/isis/applib/annotation/DomainService.java | 1 +
.../java/org/apache/isis/applib/annotation/DomainServiceLayout.java | 2 ++
.../src/main/java/org/apache/isis/applib/annotation/Editing.java | 1 +
.../java/org/apache/isis/applib/annotation/EntityChangeKind.java | 4 ++++
.../main/java/org/apache/isis/applib/annotation/EqualByContent.java | 1 +
.../src/main/java/org/apache/isis/applib/annotation/Facets.java | 1 +
.../src/main/java/org/apache/isis/applib/annotation/HomePage.java | 1 +
.../org/apache/isis/applib/annotation/IsisInteractionScope.java | 2 +-
.../main/java/org/apache/isis/applib/annotation/LabelPosition.java | 1 +
.../main/java/org/apache/isis/applib/annotation/MemberOrder.java | 1 +
.../org/apache/isis/applib/annotation/MementoSerialization.java | 1 +
.../src/main/java/org/apache/isis/applib/annotation/MinLength.java | 1 +
.../src/main/java/org/apache/isis/applib/annotation/Module.java | 3 ++-
.../src/main/java/org/apache/isis/applib/annotation/Nature.java | 1 +
.../java/org/apache/isis/applib/annotation/NatureOfService.java | 2 +-
.../src/main/java/org/apache/isis/applib/annotation/Navigable.java | 3 +--
.../main/java/org/apache/isis/applib/annotation/Optionality.java | 1 +
.../java/org/apache/isis/applib/annotation/OrderPrecedence.java | 4 ++++
.../src/main/java/org/apache/isis/applib/annotation/Parameter.java | 1 +
.../java/org/apache/isis/applib/annotation/ParameterLayout.java | 3 ++-
.../main/java/org/apache/isis/applib/annotation/Programmatic.java | 1 +
.../src/main/java/org/apache/isis/applib/annotation/Projecting.java | 4 ++++
.../main/java/org/apache/isis/applib/annotation/PromptStyle.java | 1 +
.../src/main/java/org/apache/isis/applib/annotation/Property.java | 1 +
.../main/java/org/apache/isis/applib/annotation/PropertyLayout.java | 1 +
.../src/main/java/org/apache/isis/applib/annotation/Publishing.java | 1 +
.../src/main/java/org/apache/isis/applib/annotation/Redirect.java | 1 +
.../src/main/java/org/apache/isis/applib/annotation/RenderDay.java | 1 +
.../src/main/java/org/apache/isis/applib/annotation/Repainting.java | 1 +
.../src/main/java/org/apache/isis/applib/annotation/RestrictTo.java | 1 +
.../main/java/org/apache/isis/applib/annotation/SemanticsOf.java | 1 +
.../src/main/java/org/apache/isis/applib/annotation/Title.java | 1 +
.../src/main/java/org/apache/isis/applib/annotation/Value.java | 1 +
.../src/main/java/org/apache/isis/applib/annotation/Where.java | 1 +
.../test/java/org/apache/isis/tooling/j2adoc/test/J2AdocTest.java | 5 +++--
47 files changed, 80 insertions(+), 9 deletions(-)
diff --git a/api/applib/src/main/adoc/modules/applib-ant/examples.sh b/api/applib/src/main/adoc/modules/applib-ant/examples.sh
index 5880b7b..564d90b 100644
--- a/api/applib/src/main/adoc/modules/applib-ant/examples.sh
+++ b/api/applib/src/main/adoc/modules/applib-ant/examples.sh
@@ -20,6 +20,12 @@ SRC_MAIN_JAVA=../../../java
SCRIPT_DIR=$( dirname "$0" )
cd $SCRIPT_DIR || exit 1
+echo "==================="
+echo "= MIGRATION NOTES ="
+echo "==================="
+echo "the java file examples for antora were migrated to use the global document index"
+echo "hence this script is a no-op"
+exit 0
SRC_APPLIB=$SRC_MAIN_JAVA/org/apache/isis/applib
diff --git a/api/applib/src/main/adoc/modules/applib-classes/examples.sh b/api/applib/src/main/adoc/modules/applib-classes/examples.sh
index 9d52db2..10f7a37 100644
--- a/api/applib/src/main/adoc/modules/applib-classes/examples.sh
+++ b/api/applib/src/main/adoc/modules/applib-classes/examples.sh
@@ -20,6 +20,12 @@ SRC_MAIN_JAVA=../../../java
SCRIPT_DIR=$( dirname "$0" )
cd $SCRIPT_DIR || exit 1
+echo "==================="
+echo "= MIGRATION NOTES ="
+echo "==================="
+echo "the java file examples for antora were migrated to use the global document index"
+echo "hence this script is a no-op"
+exit 0
SRC_APPLIB=$SRC_MAIN_JAVA/org/apache/isis/applib
diff --git a/api/applib/src/main/adoc/modules/applib-svc/examples.sh b/api/applib/src/main/adoc/modules/applib-svc/examples.sh
index 87d858c..3f74ca9 100644
--- a/api/applib/src/main/adoc/modules/applib-svc/examples.sh
+++ b/api/applib/src/main/adoc/modules/applib-svc/examples.sh
@@ -23,7 +23,7 @@ cd $SCRIPT_DIR || exit 1
echo "==================="
echo "= MIGRATION NOTES ="
echo "==================="
-echo "the java file list (below) was migrated to use the global document index instead (module system overview)"
+echo "the java file examples for antora were migrated to use the global document index"
echo "hence this script is a no-op"
exit 0
diff --git a/api/applib/src/main/java/org/apache/isis/applib/annotation/Action.java b/api/applib/src/main/java/org/apache/isis/applib/annotation/Action.java
index 94d2587..37da6ce 100644
--- a/api/applib/src/main/java/org/apache/isis/applib/annotation/Action.java
+++ b/api/applib/src/main/java/org/apache/isis/applib/annotation/Action.java
@@ -36,6 +36,7 @@ import org.apache.isis.applib.services.publishing.spi.ExecutionSubscriber;
/**
* Domain semantics for domain object collection.
+ * @since 1.x {@index}
*/
// tag::refguide[]
@Inherited
diff --git a/api/applib/src/main/java/org/apache/isis/applib/annotation/ActionLayout.java b/api/applib/src/main/java/org/apache/isis/applib/annotation/ActionLayout.java
index db278d6..c002281 100644
--- a/api/applib/src/main/java/org/apache/isis/applib/annotation/ActionLayout.java
+++ b/api/applib/src/main/java/org/apache/isis/applib/annotation/ActionLayout.java
@@ -31,6 +31,7 @@ import org.apache.isis.applib.layout.component.CssClassFaPosition;
/**
* Layout hints for actions.
+ * @since 1.x {@index}
*/
// tag::refguide[]
@Inherited
diff --git a/api/applib/src/main/java/org/apache/isis/applib/annotation/BookmarkPolicy.java b/api/applib/src/main/java/org/apache/isis/applib/annotation/BookmarkPolicy.java
index a17a903..daaf720 100644
--- a/api/applib/src/main/java/org/apache/isis/applib/annotation/BookmarkPolicy.java
+++ b/api/applib/src/main/java/org/apache/isis/applib/annotation/BookmarkPolicy.java
@@ -21,6 +21,10 @@ package org.apache.isis.applib.annotation;
import javax.xml.bind.annotation.XmlType;
+/**
+ *
+ * @since 1.x {@index}
+ */
// tag::refguide[]
@XmlType(
namespace = "http://isis.apache.org/applib/layout/component"
diff --git a/api/applib/src/main/java/org/apache/isis/applib/annotation/Bounding.java b/api/applib/src/main/java/org/apache/isis/applib/annotation/Bounding.java
index 4e18848..6c89883 100644
--- a/api/applib/src/main/java/org/apache/isis/applib/annotation/Bounding.java
+++ b/api/applib/src/main/java/org/apache/isis/applib/annotation/Bounding.java
@@ -20,6 +20,8 @@ package org.apache.isis.applib.annotation;
/**
* Whether the set of instances of a domain object is bounded or not.
+ *
+ * @since 1.x {@index}
*/
// tag::refguide[]
public enum Bounding {
diff --git a/api/applib/src/main/java/org/apache/isis/applib/annotation/Collection.java b/api/applib/src/main/java/org/apache/isis/applib/annotation/Collection.java
index 33aeaf3..5e70712 100644
--- a/api/applib/src/main/java/org/apache/isis/applib/annotation/Collection.java
+++ b/api/applib/src/main/java/org/apache/isis/applib/annotation/Collection.java
@@ -29,6 +29,8 @@ import org.apache.isis.applib.events.domain.CollectionDomainEvent;
/**
* Domain semantics for domain object collection.
+ *
+ * @since 1.x {@index}
*/
// tag::refguide[]
@Inherited
diff --git a/api/applib/src/main/java/org/apache/isis/applib/annotation/CollectionLayout.java b/api/applib/src/main/java/org/apache/isis/applib/annotation/CollectionLayout.java
index 29a87f0..9b2b863 100644
--- a/api/applib/src/main/java/org/apache/isis/applib/annotation/CollectionLayout.java
+++ b/api/applib/src/main/java/org/apache/isis/applib/annotation/CollectionLayout.java
@@ -28,6 +28,8 @@ import java.util.Comparator;
/**
* Layout hints for collections.
+ *
+ * @since 1.x {@index}
*/
// tag::refguide[]
@Inherited
diff --git a/api/applib/src/main/java/org/apache/isis/applib/annotation/Defaulted.java b/api/applib/src/main/java/org/apache/isis/applib/annotation/Defaulted.java
index ad4bc6f..b4773ff 100644
--- a/api/applib/src/main/java/org/apache/isis/applib/annotation/Defaulted.java
+++ b/api/applib/src/main/java/org/apache/isis/applib/annotation/Defaulted.java
@@ -47,6 +47,7 @@ import org.apache.isis.applib.adapters.DefaultsProvider;
* <p>
* Note: This annotation is only incompletely recognized by the framework, and may be deprecated in the future.
* </p>
+ * @since 1.x {@index}
*/
// tag::refguide[]
@Inherited
diff --git a/api/applib/src/main/java/org/apache/isis/applib/annotation/DomainObject.java b/api/applib/src/main/java/org/apache/isis/applib/annotation/DomainObject.java
index 9987b6e..2ce3ba2 100644
--- a/api/applib/src/main/java/org/apache/isis/applib/annotation/DomainObject.java
+++ b/api/applib/src/main/java/org/apache/isis/applib/annotation/DomainObject.java
@@ -44,6 +44,8 @@ import org.apache.isis.applib.events.lifecycle.ObjectUpdatingEvent;
* @apiNote Meta annotation {@link Component} allows for the Spring framework to pick up (discover) the
* annotated type.
* For more details see <code>org.apache.isis.core.config.beans.IsisBeanFactoryPostProcessorForSpring</code>
+ *
+ * @since 1.x {@index}
*/
// tag::refguide[]
@Inherited
diff --git a/api/applib/src/main/java/org/apache/isis/applib/annotation/DomainObjectLayout.java b/api/applib/src/main/java/org/apache/isis/applib/annotation/DomainObjectLayout.java
index f7490c8..529292b 100644
--- a/api/applib/src/main/java/org/apache/isis/applib/annotation/DomainObjectLayout.java
+++ b/api/applib/src/main/java/org/apache/isis/applib/annotation/DomainObjectLayout.java
@@ -33,6 +33,9 @@ import org.apache.isis.applib.layout.component.CssClassFaPosition;
/**
* Layout hints for domain objects.
+ *
+ *
+ * @since 1.x {@index}
*/
// tag::refguide[]
@Inherited
diff --git a/api/applib/src/main/java/org/apache/isis/applib/annotation/DomainService.java b/api/applib/src/main/java/org/apache/isis/applib/annotation/DomainService.java
index 90b9510..3e1408f 100644
--- a/api/applib/src/main/java/org/apache/isis/applib/annotation/DomainService.java
+++ b/api/applib/src/main/java/org/apache/isis/applib/annotation/DomainService.java
@@ -40,6 +40,7 @@ import org.springframework.stereotype.Service;
* annotated type.
* For more details see {@link org.apache.isis.core.config.beans.IsisBeanFactoryPostProcessorForSpring}.
*
+ * @since 1.x {@index}
*/
// tag::refguide[]
@Inherited
diff --git a/api/applib/src/main/java/org/apache/isis/applib/annotation/DomainServiceLayout.java b/api/applib/src/main/java/org/apache/isis/applib/annotation/DomainServiceLayout.java
index bedfcdb..7a67669 100644
--- a/api/applib/src/main/java/org/apache/isis/applib/annotation/DomainServiceLayout.java
+++ b/api/applib/src/main/java/org/apache/isis/applib/annotation/DomainServiceLayout.java
@@ -31,6 +31,8 @@ import java.lang.annotation.Target;
* <p>
* Also indicates the name, and menu ordering UI hints.
* </p>
+ *
+ * @since 1.x {@index}
*/
// tag::refguide[]
@Inherited
diff --git a/api/applib/src/main/java/org/apache/isis/applib/annotation/Editing.java b/api/applib/src/main/java/org/apache/isis/applib/annotation/Editing.java
index 32c1761..e5c6201 100644
--- a/api/applib/src/main/java/org/apache/isis/applib/annotation/Editing.java
+++ b/api/applib/src/main/java/org/apache/isis/applib/annotation/Editing.java
@@ -20,6 +20,7 @@ package org.apache.isis.applib.annotation;
/**
* The available policies for editing properties and collections.
+ * @since 1.x {@index}
*/
// tag::refguide[]
public enum Editing {
diff --git a/api/applib/src/main/java/org/apache/isis/applib/annotation/EntityChangeKind.java b/api/applib/src/main/java/org/apache/isis/applib/annotation/EntityChangeKind.java
index c5853eb..8365963 100644
--- a/api/applib/src/main/java/org/apache/isis/applib/annotation/EntityChangeKind.java
+++ b/api/applib/src/main/java/org/apache/isis/applib/annotation/EntityChangeKind.java
@@ -18,6 +18,10 @@
*/
package org.apache.isis.applib.annotation;
+/**
+ *
+ * @since 1.x {@index}
+ */
// tag::refguide[]
public enum EntityChangeKind {
diff --git a/api/applib/src/main/java/org/apache/isis/applib/annotation/EqualByContent.java b/api/applib/src/main/java/org/apache/isis/applib/annotation/EqualByContent.java
index b907f48..fa8849d 100644
--- a/api/applib/src/main/java/org/apache/isis/applib/annotation/EqualByContent.java
+++ b/api/applib/src/main/java/org/apache/isis/applib/annotation/EqualByContent.java
@@ -56,6 +56,7 @@ import java.util.HashMap;
* <p>
* Note: This annotation is only incompletely recognized by the framework, and may be deprecated in the future.
* </p>
+ * @since 1.x {@index}
*/
// tag::refguide[]
@Inherited
diff --git a/api/applib/src/main/java/org/apache/isis/applib/annotation/Facets.java b/api/applib/src/main/java/org/apache/isis/applib/annotation/Facets.java
index 8be974f..b079cc0 100644
--- a/api/applib/src/main/java/org/apache/isis/applib/annotation/Facets.java
+++ b/api/applib/src/main/java/org/apache/isis/applib/annotation/Facets.java
@@ -32,6 +32,7 @@ import java.lang.annotation.Target;
* <p>
* At least one named factory (as per {@link #facetFactoryNames()}) or one class
* factory (as per {@link #facetFactoryClasses()}) should be specified.
+ * @since 1.x {@index}
*/
// tag::refguide[]
@Inherited
diff --git a/api/applib/src/main/java/org/apache/isis/applib/annotation/HomePage.java b/api/applib/src/main/java/org/apache/isis/applib/annotation/HomePage.java
index 014f8e5..a5c2127 100644
--- a/api/applib/src/main/java/org/apache/isis/applib/annotation/HomePage.java
+++ b/api/applib/src/main/java/org/apache/isis/applib/annotation/HomePage.java
@@ -33,6 +33,7 @@ import java.lang.annotation.Target;
* Typically it will use injected repositories in order to display a dashboard, and offer actions
* to traverse or operate on the rendered state.
* </p>
+ * @since 2.0 {@index}
*/
// tag::refguide[]
@Inherited
diff --git a/api/applib/src/main/java/org/apache/isis/applib/annotation/IsisInteractionScope.java b/api/applib/src/main/java/org/apache/isis/applib/annotation/IsisInteractionScope.java
index 216f75d..f69da06 100644
--- a/api/applib/src/main/java/org/apache/isis/applib/annotation/IsisInteractionScope.java
+++ b/api/applib/src/main/java/org/apache/isis/applib/annotation/IsisInteractionScope.java
@@ -36,7 +36,7 @@ import org.springframework.context.annotation.Scope;
* <p>{@code @IsisInteractionScope} may be used as a meta-annotation to create custom
* composed annotations.
*
- * @since 2.0
+ * @since 2.0 {@index}
* @see org.springframework.web.context.annotation.SessionScope
* @see org.springframework.web.context.annotation.ApplicationScope
* @see org.springframework.context.annotation.Scope
diff --git a/api/applib/src/main/java/org/apache/isis/applib/annotation/LabelPosition.java b/api/applib/src/main/java/org/apache/isis/applib/annotation/LabelPosition.java
index 5ac5aa1..818b60e 100644
--- a/api/applib/src/main/java/org/apache/isis/applib/annotation/LabelPosition.java
+++ b/api/applib/src/main/java/org/apache/isis/applib/annotation/LabelPosition.java
@@ -23,6 +23,7 @@ import javax.xml.bind.annotation.XmlType;
/**
* The positioning of a label for a property or action parameter.
*
+ * @since 1.x {@index}
* @see org.apache.isis.applib.annotation.PropertyLayout
* @see org.apache.isis.applib.annotation.ParameterLayout
*/
diff --git a/api/applib/src/main/java/org/apache/isis/applib/annotation/MemberOrder.java b/api/applib/src/main/java/org/apache/isis/applib/annotation/MemberOrder.java
index 54a49dc..999d08b 100644
--- a/api/applib/src/main/java/org/apache/isis/applib/annotation/MemberOrder.java
+++ b/api/applib/src/main/java/org/apache/isis/applib/annotation/MemberOrder.java
@@ -32,6 +32,7 @@ import java.lang.annotation.Target;
* An alternative is to use the <code>Xxx.layout.xml</code> file,
* where <code>Xxx</code> is the domain object name.
* </p>
+ * @since 1.x {@index}
*/
// tag::refguide[]
@Inherited
diff --git a/api/applib/src/main/java/org/apache/isis/applib/annotation/MementoSerialization.java b/api/applib/src/main/java/org/apache/isis/applib/annotation/MementoSerialization.java
index a4f9410..c7f8a8a 100644
--- a/api/applib/src/main/java/org/apache/isis/applib/annotation/MementoSerialization.java
+++ b/api/applib/src/main/java/org/apache/isis/applib/annotation/MementoSerialization.java
@@ -20,6 +20,7 @@ package org.apache.isis.applib.annotation;
/**
* Whether the property or collection is included if the domain object is serialized into a memento.
+ * @since 1.x {@index}
*/
// tag::refguide[]
public enum MementoSerialization {
diff --git a/api/applib/src/main/java/org/apache/isis/applib/annotation/MinLength.java b/api/applib/src/main/java/org/apache/isis/applib/annotation/MinLength.java
index 469a0e3..9f4c824 100644
--- a/api/applib/src/main/java/org/apache/isis/applib/annotation/MinLength.java
+++ b/api/applib/src/main/java/org/apache/isis/applib/annotation/MinLength.java
@@ -27,6 +27,7 @@ import java.lang.annotation.Target;
/**
* Specify the minimum number of characters for an autocomplete search argument.
+ * @since 1.x {@index}
*/
// tag::refguide[]
@Inherited
diff --git a/api/applib/src/main/java/org/apache/isis/applib/annotation/Module.java b/api/applib/src/main/java/org/apache/isis/applib/annotation/Module.java
index b9e82b3..92528cf 100644
--- a/api/applib/src/main/java/org/apache/isis/applib/annotation/Module.java
+++ b/api/applib/src/main/java/org/apache/isis/applib/annotation/Module.java
@@ -44,7 +44,8 @@ import org.springframework.context.annotation.Import;
* Also, a {@link Module @Module} also declares the Spring {@link ComponentScan @ComponentScan} (with no parameters),
* which means that any domain services in the same package or subpackages are automatically found and registered.
* </p>
- *
+ *
+ * @since 1.x {@index}
* @implNote - there are possible performance implications from using this annotation, because it may result in
* scanning more classes than are needed. It is therefore not used within the framework code, but is
* provided as a convenience by domain applications.
diff --git a/api/applib/src/main/java/org/apache/isis/applib/annotation/Nature.java b/api/applib/src/main/java/org/apache/isis/applib/annotation/Nature.java
index 62f3e0a..22615f8 100644
--- a/api/applib/src/main/java/org/apache/isis/applib/annotation/Nature.java
+++ b/api/applib/src/main/java/org/apache/isis/applib/annotation/Nature.java
@@ -27,6 +27,7 @@ import javax.xml.bind.annotation.XmlRootElement;
* Note that {@link #EXTERNAL_ENTITY} and {@link #VIEW_MODEL} are implemented identically internally; the
* difference is one of intent.
* </p>
+ * @since 1.x {@index}
*/
// tag::refguide[]
public enum Nature {
diff --git a/api/applib/src/main/java/org/apache/isis/applib/annotation/NatureOfService.java b/api/applib/src/main/java/org/apache/isis/applib/annotation/NatureOfService.java
index 7d10459..8e05cb6 100644
--- a/api/applib/src/main/java/org/apache/isis/applib/annotation/NatureOfService.java
+++ b/api/applib/src/main/java/org/apache/isis/applib/annotation/NatureOfService.java
@@ -20,7 +20,7 @@ package org.apache.isis.applib.annotation;
/**
* The different sorts of domain services recognized by Isis, as specified in {@link DomainService#nature()}
- *
+ * @since 1.x {@index}
*/
// tag::refguide[]
public enum NatureOfService {
diff --git a/api/applib/src/main/java/org/apache/isis/applib/annotation/Navigable.java b/api/applib/src/main/java/org/apache/isis/applib/annotation/Navigable.java
index d4ba91e..6ffa291 100644
--- a/api/applib/src/main/java/org/apache/isis/applib/annotation/Navigable.java
+++ b/api/applib/src/main/java/org/apache/isis/applib/annotation/Navigable.java
@@ -23,8 +23,7 @@ package org.apache.isis.applib.annotation;
* Tells the framework which method or field to use in order to construct a navigable chain of
* parent domain object instances. The Navigable.PARENT 'flag' can only be used once per class declaration.
*
- * @since 2.0
- *
+ * @since 2.0 {@index}
*/
// tag::refguide[]
public enum Navigable {
diff --git a/api/applib/src/main/java/org/apache/isis/applib/annotation/Optionality.java b/api/applib/src/main/java/org/apache/isis/applib/annotation/Optionality.java
index 9389e42..c19616c 100644
--- a/api/applib/src/main/java/org/apache/isis/applib/annotation/Optionality.java
+++ b/api/applib/src/main/java/org/apache/isis/applib/annotation/Optionality.java
@@ -20,6 +20,7 @@ package org.apache.isis.applib.annotation;
/**
* Whether the property or parameter is optional or is required (aka mandatory).
+ * @since 1.x {@index}
*/
// tag::refguide[]
public enum Optionality {
diff --git a/api/applib/src/main/java/org/apache/isis/applib/annotation/OrderPrecedence.java b/api/applib/src/main/java/org/apache/isis/applib/annotation/OrderPrecedence.java
index e4caea8..98b394c 100644
--- a/api/applib/src/main/java/org/apache/isis/applib/annotation/OrderPrecedence.java
+++ b/api/applib/src/main/java/org/apache/isis/applib/annotation/OrderPrecedence.java
@@ -23,6 +23,10 @@ import org.springframework.core.Ordered;
import lombok.experimental.UtilityClass;
+/**
+ *
+ * @since 1.x {@index}
+ */
// tag::refguide[]
@UtilityClass
public class OrderPrecedence {
diff --git a/api/applib/src/main/java/org/apache/isis/applib/annotation/Parameter.java b/api/applib/src/main/java/org/apache/isis/applib/annotation/Parameter.java
index 725fbfd..14ae1c6 100644
--- a/api/applib/src/main/java/org/apache/isis/applib/annotation/Parameter.java
+++ b/api/applib/src/main/java/org/apache/isis/applib/annotation/Parameter.java
@@ -31,6 +31,7 @@ import org.apache.isis.applib.value.Clob;
/**
* Domain semantics for domain object collection.
+ * @since 1.x {@index}
*/
// tag::refguide[]
@Inherited
diff --git a/api/applib/src/main/java/org/apache/isis/applib/annotation/ParameterLayout.java b/api/applib/src/main/java/org/apache/isis/applib/annotation/ParameterLayout.java
index 04b7ee3..3972fd4 100644
--- a/api/applib/src/main/java/org/apache/isis/applib/annotation/ParameterLayout.java
+++ b/api/applib/src/main/java/org/apache/isis/applib/annotation/ParameterLayout.java
@@ -27,7 +27,8 @@ import java.lang.annotation.Target;
/**
* Layout hints for action parameters.
- *
+ *
+ * @since 1.x {@index}
* @see org.apache.isis.applib.annotation.PropertyLayout
*/
// tag::refguide[]
diff --git a/api/applib/src/main/java/org/apache/isis/applib/annotation/Programmatic.java b/api/applib/src/main/java/org/apache/isis/applib/annotation/Programmatic.java
index 215bf43..3ef620c 100644
--- a/api/applib/src/main/java/org/apache/isis/applib/annotation/Programmatic.java
+++ b/api/applib/src/main/java/org/apache/isis/applib/annotation/Programmatic.java
@@ -38,6 +38,7 @@ import java.lang.annotation.Target;
* It can also be added to a type, meaning that the type is ignored from the metamodel.
* This is intended as a "get out of jail" for any classes from unit tests, say,
* that end up on the classpath of integration tests but should otherwise be ignored.
+ * @since 1.x {@index}
*/
// tag::refguide[]
@Inherited
diff --git a/api/applib/src/main/java/org/apache/isis/applib/annotation/Projecting.java b/api/applib/src/main/java/org/apache/isis/applib/annotation/Projecting.java
index 82b7a74..90ca55a 100644
--- a/api/applib/src/main/java/org/apache/isis/applib/annotation/Projecting.java
+++ b/api/applib/src/main/java/org/apache/isis/applib/annotation/Projecting.java
@@ -18,6 +18,10 @@
*/
package org.apache.isis.applib.annotation;
+/**
+ *
+ * @since 1.x {@index}
+ */
// tag::refguide[]
public enum Projecting {
diff --git a/api/applib/src/main/java/org/apache/isis/applib/annotation/PromptStyle.java b/api/applib/src/main/java/org/apache/isis/applib/annotation/PromptStyle.java
index df7e313..ac5b95f 100644
--- a/api/applib/src/main/java/org/apache/isis/applib/annotation/PromptStyle.java
+++ b/api/applib/src/main/java/org/apache/isis/applib/annotation/PromptStyle.java
@@ -22,6 +22,7 @@ import javax.xml.bind.annotation.XmlType;
/**
* How prompting for new values of a property/arguments for an action should be performed
+ * @since 1.x {@index}
*/
// tag::refguide[]
@XmlType(
diff --git a/api/applib/src/main/java/org/apache/isis/applib/annotation/Property.java b/api/applib/src/main/java/org/apache/isis/applib/annotation/Property.java
index 328f6c7..ecf483c 100644
--- a/api/applib/src/main/java/org/apache/isis/applib/annotation/Property.java
+++ b/api/applib/src/main/java/org/apache/isis/applib/annotation/Property.java
@@ -39,6 +39,7 @@ import org.apache.isis.applib.value.Clob;
/**
* Domain semantics for domain object property.
+ * @since 1.x {@index}
*/
// tag::refguide[]
@Inherited
diff --git a/api/applib/src/main/java/org/apache/isis/applib/annotation/PropertyLayout.java b/api/applib/src/main/java/org/apache/isis/applib/annotation/PropertyLayout.java
index f1dafd0..6d8a1f7 100644
--- a/api/applib/src/main/java/org/apache/isis/applib/annotation/PropertyLayout.java
+++ b/api/applib/src/main/java/org/apache/isis/applib/annotation/PropertyLayout.java
@@ -28,6 +28,7 @@ import java.lang.annotation.Target;
/**
* Layout hints for properties.
*
+ * @since 1.x {@index}
* @see org.apache.isis.applib.annotation.ParameterLayout
*/
// tag::refguide[]
diff --git a/api/applib/src/main/java/org/apache/isis/applib/annotation/Publishing.java b/api/applib/src/main/java/org/apache/isis/applib/annotation/Publishing.java
index 781ed01..7d63091 100644
--- a/api/applib/src/main/java/org/apache/isis/applib/annotation/Publishing.java
+++ b/api/applib/src/main/java/org/apache/isis/applib/annotation/Publishing.java
@@ -37,6 +37,7 @@ import org.apache.isis.applib.services.publishing.spi.ExecutionSubscriber;
* <li><b>{@link Command} ... subscribed to via {@link CommandSubscriber}</li>
* <li><b>{@link Interaction.Execution} ... subscribed to via {@link ExecutionSubscriber}</li>
* </ul>
+ * @since 1.x {@index}
*/
// tag::refguide[]
public enum Publishing {
diff --git a/api/applib/src/main/java/org/apache/isis/applib/annotation/Redirect.java b/api/applib/src/main/java/org/apache/isis/applib/annotation/Redirect.java
index c771535..9674630 100644
--- a/api/applib/src/main/java/org/apache/isis/applib/annotation/Redirect.java
+++ b/api/applib/src/main/java/org/apache/isis/applib/annotation/Redirect.java
@@ -23,6 +23,7 @@ import javax.xml.bind.annotation.XmlType;
/**
* The available policies for rendering the next page if the result is the same as the target
* (in other words, an action that returns "this").
+ * @since 1.x {@index}
*/
// tag::refguide[]
@XmlType(
diff --git a/api/applib/src/main/java/org/apache/isis/applib/annotation/RenderDay.java b/api/applib/src/main/java/org/apache/isis/applib/annotation/RenderDay.java
index 15d79ed..9fc7713 100644
--- a/api/applib/src/main/java/org/apache/isis/applib/annotation/RenderDay.java
+++ b/api/applib/src/main/java/org/apache/isis/applib/annotation/RenderDay.java
@@ -22,6 +22,7 @@ import javax.xml.bind.annotation.XmlType;
/**
* How to render days.
+ * @since 1.x {@index}
*/
// tag::refguide[]
@XmlType(
diff --git a/api/applib/src/main/java/org/apache/isis/applib/annotation/Repainting.java b/api/applib/src/main/java/org/apache/isis/applib/annotation/Repainting.java
index ed7c88e..14d731c 100644
--- a/api/applib/src/main/java/org/apache/isis/applib/annotation/Repainting.java
+++ b/api/applib/src/main/java/org/apache/isis/applib/annotation/Repainting.java
@@ -22,6 +22,7 @@ import javax.xml.bind.annotation.XmlType;
/**
* Whether a component is unchanging and so does not require repainting.
+ * @since 1.x {@index}
*/
// tag::refguide[]
@XmlType(
diff --git a/api/applib/src/main/java/org/apache/isis/applib/annotation/RestrictTo.java b/api/applib/src/main/java/org/apache/isis/applib/annotation/RestrictTo.java
index b7b395d..0b976a6 100644
--- a/api/applib/src/main/java/org/apache/isis/applib/annotation/RestrictTo.java
+++ b/api/applib/src/main/java/org/apache/isis/applib/annotation/RestrictTo.java
@@ -20,6 +20,7 @@ package org.apache.isis.applib.annotation;
/**
* Whether an action is restricted to development mode, or available in all.
+ * @since 1.x {@index}
*/
// tag::refguide[]
public enum RestrictTo {
diff --git a/api/applib/src/main/java/org/apache/isis/applib/annotation/SemanticsOf.java b/api/applib/src/main/java/org/apache/isis/applib/annotation/SemanticsOf.java
index 49a0436..34f2321 100644
--- a/api/applib/src/main/java/org/apache/isis/applib/annotation/SemanticsOf.java
+++ b/api/applib/src/main/java/org/apache/isis/applib/annotation/SemanticsOf.java
@@ -21,6 +21,7 @@ package org.apache.isis.applib.annotation;
import org.apache.isis.applib.util.Enums;
/**
+ * @since 1.x {@index}
* @see <a href="https://isis.apache.org/guides/rgant/rgant.html#_rgant-Action_semantics">Reference Guide</a>
*/
// tag::refguide[]
diff --git a/api/applib/src/main/java/org/apache/isis/applib/annotation/Title.java b/api/applib/src/main/java/org/apache/isis/applib/annotation/Title.java
index b6cd0c1..1bf90a7 100644
--- a/api/applib/src/main/java/org/apache/isis/applib/annotation/Title.java
+++ b/api/applib/src/main/java/org/apache/isis/applib/annotation/Title.java
@@ -27,6 +27,7 @@ import java.lang.annotation.Target;
/**
* A title annotation used to annotate methods used to construct the title of a
* domain object instance. It is used as a marker.
+ * @since 1.x {@index}
*/
// tag::refguide[]
@Retention(RetentionPolicy.RUNTIME)
diff --git a/api/applib/src/main/java/org/apache/isis/applib/annotation/Value.java b/api/applib/src/main/java/org/apache/isis/applib/annotation/Value.java
index 446bf84..904a43a 100644
--- a/api/applib/src/main/java/org/apache/isis/applib/annotation/Value.java
+++ b/api/applib/src/main/java/org/apache/isis/applib/annotation/Value.java
@@ -48,6 +48,7 @@ import org.apache.isis.applib.adapters.ValueSemanticsProvider;
* the flyweight pattern). In addition, the {@link EqualByContent} semantic
* means that we needn't care whether value types are being shared or not.
*
+ * @since 1.x {@index}
* @see EqualByContent
*
* <p>
diff --git a/api/applib/src/main/java/org/apache/isis/applib/annotation/Where.java b/api/applib/src/main/java/org/apache/isis/applib/annotation/Where.java
index c1d01c2..d834eb7 100644
--- a/api/applib/src/main/java/org/apache/isis/applib/annotation/Where.java
+++ b/api/applib/src/main/java/org/apache/isis/applib/annotation/Where.java
@@ -39,6 +39,7 @@ import org.apache.isis.applib.util.Enums;
* <p>
* This enum is also used internally within the framework. When rendering an element,
* the framework developer should only use those values that represent concrete locations.
+ * @since 1.x {@index}
*/
// tag::refguide[]
@XmlType(
diff --git a/tooling/java2adoc/src/test/java/org/apache/isis/tooling/j2adoc/test/J2AdocTest.java b/tooling/java2adoc/src/test/java/org/apache/isis/tooling/j2adoc/test/J2AdocTest.java
index e206ab2..f7d73e5 100644
--- a/tooling/java2adoc/src/test/java/org/apache/isis/tooling/j2adoc/test/J2AdocTest.java
+++ b/tooling/java2adoc/src/test/java/org/apache/isis/tooling/j2adoc/test/J2AdocTest.java
@@ -59,8 +59,9 @@ class J2AdocTest {
analyzerConfig.getSources(JAVA)
.stream()
//.filter(source->source.toString().contains("ExecutionMode"))
- .filter(source->source.toString().contains("FactoryService"))
- //.peek(source->System.out.println("parsing source: " + source))
+ //.filter(source->source.toString().contains("FactoryService"))
+ .filter(source->source.toString().contains("Action"))
+ .peek(source->System.out.println("parsing source: " + source))
.forEach(j2aContext::add);
j2aContext.streamUnits()