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 2018/01/23 15:36:12 UTC
[isis] 01/02: ISIS-1846 java-doc: simplify warnings for internal
API use
This is an automated email from the ASF dual-hosted git repository.
ahuber pushed a commit to branch ISIS-1846_internal_utils
in repository https://gitbox.apache.org/repos/asf/isis.git
commit 7743f0b9587fe5c797d909e1988b3d4382ef8575
Author: Andi Huber <ah...@apache.org>
AuthorDate: Tue Jan 23 13:29:07 2018 +0100
ISIS-1846 java-doc: simplify warnings for internal API use
---
.../main/java/org/apache/isis/applib/internal/_Constants.java | 6 ++++--
.../java/org/apache/isis/applib/internal/base/_Casts.java | 6 ++++--
.../java/org/apache/isis/applib/internal/base/_NullSafe.java | 6 ++++--
.../java/org/apache/isis/applib/internal/base/_Strings.java | 8 +++++---
.../org/apache/isis/applib/internal/base/package-info.java | 11 +++++++----
.../org/apache/isis/applib/internal/compare/_Comparators.java | 6 ++++--
.../org/apache/isis/applib/internal/compare/package-info.java | 11 +++++++----
.../apache/isis/applib/internal/exceptions/_Exceptions.java | 6 ++++--
.../apache/isis/applib/internal/exceptions/package-info.java | 11 +++++++----
.../java/org/apache/isis/applib/internal/package-info.java | 11 +++++++----
10 files changed, 53 insertions(+), 29 deletions(-)
diff --git a/core/applib/src/main/java/org/apache/isis/applib/internal/_Constants.java b/core/applib/src/main/java/org/apache/isis/applib/internal/_Constants.java
index 90bb428..6682a56 100644
--- a/core/applib/src/main/java/org/apache/isis/applib/internal/_Constants.java
+++ b/core/applib/src/main/java/org/apache/isis/applib/internal/_Constants.java
@@ -23,9 +23,11 @@ package org.apache.isis.applib.internal;
* <h1>- internal use only -</h1>
* <p>
* A collection of commonly used constants.
+ * </p>
* <p>
- * WARNING: Do <b>NOT</b> use any of the classes provided by this package! <br/>
- * Public access will be removed once we migrate to Java 9+ modules.
+ * <b>WARNING</b>: Do <b>NOT</b> use any of the classes provided by this package! <br/>
+ * These may be changed or removed without notice!
+ * </p>
*
* @since 2.0.0
*/
diff --git a/core/applib/src/main/java/org/apache/isis/applib/internal/base/_Casts.java b/core/applib/src/main/java/org/apache/isis/applib/internal/base/_Casts.java
index 0e97680..30713a9 100644
--- a/core/applib/src/main/java/org/apache/isis/applib/internal/base/_Casts.java
+++ b/core/applib/src/main/java/org/apache/isis/applib/internal/base/_Casts.java
@@ -23,9 +23,11 @@ package org.apache.isis.applib.internal.base;
* <h1>- internal use only -</h1>
* <p>
* Casting Utilities
+ * </p>
* <p>
- * WARNING: Do <b>NOT</b> use any of the classes provided by this package! <br/>
- * Public access will be removed once we migrate to Java 9+ modules.
+ * <b>WARNING</b>: Do <b>NOT</b> use any of the classes provided by this package! <br/>
+ * These may be changed or removed without notice!
+ * </p>
*
* @since 2.0.0
*/
diff --git a/core/applib/src/main/java/org/apache/isis/applib/internal/base/_NullSafe.java b/core/applib/src/main/java/org/apache/isis/applib/internal/base/_NullSafe.java
index ae9b277..87d4073 100644
--- a/core/applib/src/main/java/org/apache/isis/applib/internal/base/_NullSafe.java
+++ b/core/applib/src/main/java/org/apache/isis/applib/internal/base/_NullSafe.java
@@ -31,9 +31,11 @@ import java.util.stream.StreamSupport;
* <p>
* Provides convenient null check / null safe methods primarily
* to shortcut null-check idioms.
+ * </p>
* <p>
- * WARNING: Do <b>NOT</b> use any of the classes provided by this package! <br/>
- * Public access will be removed once we migrate to Java 9+ modules.
+ * <b>WARNING</b>: Do <b>NOT</b> use any of the classes provided by this package! <br/>
+ * These may be changed or removed without notice!
+ * </p>
*
* @since 2.0.0
*
diff --git a/core/applib/src/main/java/org/apache/isis/applib/internal/base/_Strings.java b/core/applib/src/main/java/org/apache/isis/applib/internal/base/_Strings.java
index 52744da..02613f1 100644
--- a/core/applib/src/main/java/org/apache/isis/applib/internal/base/_Strings.java
+++ b/core/applib/src/main/java/org/apache/isis/applib/internal/base/_Strings.java
@@ -34,12 +34,14 @@ import javax.annotation.Nullable;
* <h1>- internal use only -</h1>
* <p>
* Provides String related algorithms.
- * <p>
+ * </p><p>
* Keep the public methods simple, these are basic building blocks for more complex composites.
* Composites are provided as static fields.
+ * </p>
* <p>
- * WARNING: Do <b>NOT</b> use any of the classes provided by this package! <br/>
- * Public access will be removed once we migrate to Java 9+ modules.
+ * <b>WARNING</b>: Do <b>NOT</b> use any of the classes provided by this package! <br/>
+ * These may be changed or removed without notice!
+ * </p>
*
* @since 2.0.0
*/
diff --git a/core/applib/src/main/java/org/apache/isis/applib/internal/base/package-info.java b/core/applib/src/main/java/org/apache/isis/applib/internal/base/package-info.java
index 527aa62..d2b2cf0 100644
--- a/core/applib/src/main/java/org/apache/isis/applib/internal/base/package-info.java
+++ b/core/applib/src/main/java/org/apache/isis/applib/internal/base/package-info.java
@@ -17,9 +17,12 @@
* under the License.
*/
/**
- * Internal classes, not intended as being part of the public API.
- *
- * WARNING: Do NOT use any of the classes provided by this package! <br/>
- * Public access will be removed once we migrate to Java 9+ modules.
+ * <h1>Internal API</h1>
+ * Internal classes, contributing to the internal proprietary API.
+ * These may be changed or removed without notice!
+ * <p>
+ * <b>WARNING</b>:
+ * Do NOT use any of the classes provided by this package!
+ * </p>
*/
package org.apache.isis.applib.internal.base;
\ No newline at end of file
diff --git a/core/applib/src/main/java/org/apache/isis/applib/internal/compare/_Comparators.java b/core/applib/src/main/java/org/apache/isis/applib/internal/compare/_Comparators.java
index 097faa9..da189df 100644
--- a/core/applib/src/main/java/org/apache/isis/applib/internal/compare/_Comparators.java
+++ b/core/applib/src/main/java/org/apache/isis/applib/internal/compare/_Comparators.java
@@ -27,9 +27,11 @@ import javax.annotation.Nullable;
* <h1>- internal use only -</h1>
* <p>
* Provides some ordering algorithms.
+ * </p>
* <p>
- * WARNING: Do <b>NOT</b> use any of the classes provided by this package! <br/>
- * Public access will be removed once we migrate to Java 9+ modules.
+ * <b>WARNING</b>: Do <b>NOT</b> use any of the classes provided by this package! <br/>
+ * These may be changed or removed without notice!
+ * </p>
*
* @since 2.0.0
*/
diff --git a/core/applib/src/main/java/org/apache/isis/applib/internal/compare/package-info.java b/core/applib/src/main/java/org/apache/isis/applib/internal/compare/package-info.java
index 4eed78e..5ab700c 100644
--- a/core/applib/src/main/java/org/apache/isis/applib/internal/compare/package-info.java
+++ b/core/applib/src/main/java/org/apache/isis/applib/internal/compare/package-info.java
@@ -17,9 +17,12 @@
* under the License.
*/
/**
- * Internal classes, not intended as being part of the public API.
- *
- * WARNING: Do NOT use any of the classes provided by this package! <br/>
- * Public access will be removed once we migrate to Java 9+ modules.
+ * <h1>Internal API</h1>
+ * Internal classes, contributing to the internal proprietary API.
+ * These may be changed or removed without notice!
+ * <p>
+ * <b>WARNING</b>:
+ * Do NOT use any of the classes provided by this package!
+ * </p>
*/
package org.apache.isis.applib.internal.compare;
\ No newline at end of file
diff --git a/core/applib/src/main/java/org/apache/isis/applib/internal/exceptions/_Exceptions.java b/core/applib/src/main/java/org/apache/isis/applib/internal/exceptions/_Exceptions.java
index c28e5f4..7905f27 100644
--- a/core/applib/src/main/java/org/apache/isis/applib/internal/exceptions/_Exceptions.java
+++ b/core/applib/src/main/java/org/apache/isis/applib/internal/exceptions/_Exceptions.java
@@ -30,9 +30,11 @@ import org.apache.isis.applib.internal.base._NullSafe;
* <h1>- internal use only -</h1>
* <p>
* A collection of framework internal exceptions.
+ * </p>
* <p>
- * WARNING: Do <b>NOT</b> use any of the classes provided by this package! <br/>
- * Public access will be removed once we migrate to Java 9+ modules.
+ * <b>WARNING</b>: Do <b>NOT</b> use any of the classes provided by this package! <br/>
+ * These may be changed or removed without notice!
+ * </p>
*
* @since 2.0.0
*/
diff --git a/core/applib/src/main/java/org/apache/isis/applib/internal/exceptions/package-info.java b/core/applib/src/main/java/org/apache/isis/applib/internal/exceptions/package-info.java
index 8b79deb..6e178b7 100644
--- a/core/applib/src/main/java/org/apache/isis/applib/internal/exceptions/package-info.java
+++ b/core/applib/src/main/java/org/apache/isis/applib/internal/exceptions/package-info.java
@@ -17,9 +17,12 @@
* under the License.
*/
/**
- * Internal classes, not intended as being part of the public API.
- *
- * WARNING: Do NOT use any of the classes provided by this package! <br/>
- * Public access will be removed once we migrate to Java 9+ modules.
+ * <h1>Internal API</h1>
+ * Internal classes, contributing to the internal proprietary API.
+ * These may be changed or removed without notice!
+ * <p>
+ * <b>WARNING</b>:
+ * Do NOT use any of the classes provided by this package!
+ * </p>
*/
package org.apache.isis.applib.internal.exceptions;
\ No newline at end of file
diff --git a/core/applib/src/main/java/org/apache/isis/applib/internal/package-info.java b/core/applib/src/main/java/org/apache/isis/applib/internal/package-info.java
index 8851009..ae7cd45 100644
--- a/core/applib/src/main/java/org/apache/isis/applib/internal/package-info.java
+++ b/core/applib/src/main/java/org/apache/isis/applib/internal/package-info.java
@@ -17,9 +17,12 @@
* under the License.
*/
/**
- * Internal classes, not intended as being part of the public API.
- *
- * WARNING: Do NOT use any of the classes provided by this package! <br/>
- * Public access will be removed once we migrate to Java 9+ modules.
+ * <h1>Internal API</h1>
+ * Internal classes, contributing to the internal proprietary API.
+ * These may be changed or removed without notice!
+ * <p>
+ * <b>WARNING</b>:
+ * Do NOT use any of the classes provided by this package!
+ * </p>
*/
package org.apache.isis.applib.internal;
\ No newline at end of file
--
To stop receiving notification emails like this one, please contact
ahuber@apache.org.