Add experimental note to Push KDoc

bitfireAT · Apr 8, 2024 · f442808 · f442808
1 parent d3664ad
commit f442808
Show file tree

Hide file tree

Showing 6 changed files with 27 additions and 0 deletions.
diff --git a/src/main/kotlin/at/bitfire/dav4jvm/property/push/PushSubscribe.kt b/src/main/kotlin/at/bitfire/dav4jvm/property/push/PushSubscribe.kt
@@ -14,6 +14,11 @@ import at.bitfire.dav4jvm.XmlUtils.propertyName
 import org.xmlpull.v1.XmlPullParser
 import java.time.Instant
 
+/**
+ * Represents a `{DAV:Push}push-subscribe` property.
+ *
+ * Experimental! See https://github.com/bitfireAT/webdav-push/
+ */
 class PushSubscribe: Property {
 
     companion object {

diff --git a/src/main/kotlin/at/bitfire/dav4jvm/property/push/PushTransports.kt b/src/main/kotlin/at/bitfire/dav4jvm/property/push/PushTransports.kt
@@ -12,6 +12,11 @@ import at.bitfire.dav4jvm.XmlUtils
 import at.bitfire.dav4jvm.XmlUtils.propertyName
 import org.xmlpull.v1.XmlPullParser
 
+/**
+ * Represents a `{DAV:Push}push-transports` property.
+ *
+ * Experimental! See https://github.com/bitfireAT/webdav-push/
+ */
 class PushTransports private constructor(
     val transports: Set<Property.Name>
 ): Property {

diff --git a/src/main/kotlin/at/bitfire/dav4jvm/property/push/Subscription.kt b/src/main/kotlin/at/bitfire/dav4jvm/property/push/Subscription.kt
@@ -11,6 +11,11 @@ import at.bitfire.dav4jvm.PropertyFactory
 import at.bitfire.dav4jvm.XmlUtils
 import org.xmlpull.v1.XmlPullParser
 
+/**
+ * Represents a `{DAV:Push}subscription` property.
+ *
+ * Experimental! See https://github.com/bitfireAT/webdav-push/
+ */
 class Subscription private constructor(
     val webPushSubscription: WebPushSubscription
 ): Property {

diff --git a/src/main/kotlin/at/bitfire/dav4jvm/property/push/Topic.kt b/src/main/kotlin/at/bitfire/dav4jvm/property/push/Topic.kt
@@ -11,6 +11,11 @@ import at.bitfire.dav4jvm.PropertyFactory
 import at.bitfire.dav4jvm.XmlUtils
 import org.xmlpull.v1.XmlPullParser
 
+/**
+ * Represents a `{DAV:Push}topic` property.
+ *
+ * Experimental! See https://github.com/bitfireAT/webdav-push/
+ */
 class Topic private constructor(
     val topic: String
 ): Property {

diff --git a/src/main/kotlin/at/bitfire/dav4jvm/property/push/WebPushSubscription.kt b/src/main/kotlin/at/bitfire/dav4jvm/property/push/WebPushSubscription.kt
@@ -11,6 +11,11 @@ import at.bitfire.dav4jvm.PropertyFactory
 import at.bitfire.dav4jvm.XmlUtils
 import org.xmlpull.v1.XmlPullParser
 
+/**
+ * Represents a `{DAV:Push}web-push-subscription` property.
+ *
+ * Experimental! See https://github.com/bitfireAT/webdav-push/
+ */
 class WebPushSubscription: Property {
 
     companion object {

diff --git a/src/main/kotlin/at/bitfire/dav4jvm/property/push/namespace.kt b/src/main/kotlin/at/bitfire/dav4jvm/property/push/namespace.kt
@@ -9,5 +9,7 @@ package at.bitfire.dav4jvm.property.push
 /**
  * XML namespace of WebDAV-Push (draft), see:
  * https://github.com/bitfireAT/webdav-push/
+ *
+ * Experimental!
  */
 const val NS_WEBDAV_PUSH = "DAV:Push"