From e37655ecdcbdaea5c186e823eaebde1e782e2673 Mon Sep 17 00:00:00 2001
From: David Rowe <david@ctrlaltstudio.com>
Date: Wed, 11 Apr 2018 16:35:49 +1200
Subject: [PATCH 1/4] Update location.hostname JSDoc per serverless domains
---
libraries/networking/src/AddressManager.h | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/libraries/networking/src/AddressManager.h b/libraries/networking/src/AddressManager.h
index b42aec2771..6609efcf30 100644
--- a/libraries/networking/src/AddressManager.h
+++ b/libraries/networking/src/AddressManager.h
@@ -39,7 +39,7 @@ const QString GET_PLACE = "/api/v1/places/%1";
* @property {Uuid} domainId - Synonym for <code>domainId</code>. <em>Read-only.</em> <strong>Deprecated:</strong> This property
* is deprecated and will soon be removed.
* @property {string} hostname - The name of the domain for your current metaverse address (e.g., <code>"AvatarIsland"</code>,
- * <code>localhost</code>, or an IP address).
+ * <code>localhost</code>, an IP address, or the file path to a serverless domain).
* <em>Read-only.</em>
* @property {string} href - Your current metaverse address (e.g., <code>"hifi://avatarisland/15,-10,26/0,0,0,1"</code>)
* regardless of whether or not you're connected to the domain.
From c836014d213ad81db87e0274da4dd23cf68b13ad Mon Sep 17 00:00:00 2001
From: David Rowe <david@ctrlaltstudio.com>
Date: Thu, 12 Apr 2018 09:24:10 +1200
Subject: [PATCH 2/4] Fix JSDoc typo noticed in passing
---
interface/src/scripting/WindowScriptingInterface.h | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/interface/src/scripting/WindowScriptingInterface.h b/interface/src/scripting/WindowScriptingInterface.h
index e3b092d011..2d92c945f2 100644
--- a/interface/src/scripting/WindowScriptingInterface.h
+++ b/interface/src/scripting/WindowScriptingInterface.h
@@ -528,8 +528,8 @@ private slots:
signals:
/**jsdoc
- * Triggered when you change the domain you're visiting. <strong>Warning:</strong> Is not emitted if you go to domain that
- * isn't running.
+ * Triggered when you change the domain you're visiting. <strong>Warning:</strong> Is not emitted if you go to a domain
+ * that isn't running.
* @function Window.domainChanged
* @param {string} domainURL - The domain's URL.
* @returns {Signal}
From 0552a7242a7d066b9077c8ecb88bd2dceff2548d Mon Sep 17 00:00:00 2001
From: David Rowe <david@ctrlaltstudio.com>
Date: Fri, 20 Apr 2018 09:52:35 +1200
Subject: [PATCH 3/4] Further JSDoc updates for serverless domains
---
libraries/networking/src/AddressManager.h | 7 ++++---
1 file changed, 4 insertions(+), 3 deletions(-)
diff --git a/libraries/networking/src/AddressManager.h b/libraries/networking/src/AddressManager.h
index 6c6070914f..0009bef49a 100644
--- a/libraries/networking/src/AddressManager.h
+++ b/libraries/networking/src/AddressManager.h
@@ -34,15 +34,16 @@ const QString GET_PLACE = "/api/v1/places/%1";
*
* @namespace location
* @property {Uuid} domainID - A UUID uniquely identifying the domain you're visiting. Is {@link Uuid|Uuid.NULL} if you're not
- * connected to the domain.
+ * connected to the domain or are at a serverless domain.
* <em>Read-only.</em>
* @property {Uuid} domainId - Synonym for <code>domainId</code>. <em>Read-only.</em> <strong>Deprecated:</strong> This property
* is deprecated and will soon be removed.
* @property {string} hostname - The name of the domain for your current metaverse address (e.g., <code>"AvatarIsland"</code>,
- * <code>localhost</code>, an IP address, or the file path to a serverless domain).
+ * <code>localhost</code>, or an IP address). Is blank if you're at a serverless domain.
* <em>Read-only.</em>
* @property {string} href - Your current metaverse address (e.g., <code>"hifi://avatarisland/15,-10,26/0,0,0,1"</code>)
- * regardless of whether or not you're connected to the domain.
+ * regardless of whether or not you're connected to the domain. Starts with <code>"file:///"</code> if at a serverless
+ * domain.
* <em>Read-only.</em>
* @property {boolean} isConnected - <code>true</code> if you're connected to the domain in your current <code>href</code>
* metaverse address, otherwise <code>false</code>.
From 8ade4f34f4c70fe6fdb00ad82c0ba9deab22617b Mon Sep 17 00:00:00 2001
From: David Rowe <david@ctrlaltstudio.com>
Date: Fri, 20 Apr 2018 10:11:01 +1200
Subject: [PATCH 4/4] Tweak wording
---
libraries/networking/src/AddressManager.h | 8 ++++----
1 file changed, 4 insertions(+), 4 deletions(-)
diff --git a/libraries/networking/src/AddressManager.h b/libraries/networking/src/AddressManager.h
index 0009bef49a..94eff46bda 100644
--- a/libraries/networking/src/AddressManager.h
+++ b/libraries/networking/src/AddressManager.h
@@ -34,16 +34,16 @@ const QString GET_PLACE = "/api/v1/places/%1";
*
* @namespace location
* @property {Uuid} domainID - A UUID uniquely identifying the domain you're visiting. Is {@link Uuid|Uuid.NULL} if you're not
- * connected to the domain or are at a serverless domain.
+ * connected to the domain or are in a serverless domain.
* <em>Read-only.</em>
* @property {Uuid} domainId - Synonym for <code>domainId</code>. <em>Read-only.</em> <strong>Deprecated:</strong> This property
* is deprecated and will soon be removed.
* @property {string} hostname - The name of the domain for your current metaverse address (e.g., <code>"AvatarIsland"</code>,
- * <code>localhost</code>, or an IP address). Is blank if you're at a serverless domain.
+ * <code>localhost</code>, or an IP address). Is blank if you're in a serverless domain.
* <em>Read-only.</em>
* @property {string} href - Your current metaverse address (e.g., <code>"hifi://avatarisland/15,-10,26/0,0,0,1"</code>)
- * regardless of whether or not you're connected to the domain. Starts with <code>"file:///"</code> if at a serverless
- * domain.
+ * regardless of whether or not you're connected to the domain. Starts with <code>"file:///"</code> if you're in a
+ * serverless domain.
* <em>Read-only.</em>
* @property {boolean} isConnected - <code>true</code> if you're connected to the domain in your current <code>href</code>
* metaverse address, otherwise <code>false</code>.