Add some documentation around URIs and ghosts

Issue #89

[#128311253]

Author: camelpunch

RMQClient/RMQConnection.h

@@ -118,17 +118,44 @@ extern NSInteger const RMQChannelLimit;
                            delegate:(nullable id<RMQConnectionDelegate>)delegate
                       delegateQueue:(nonnull dispatch_queue_t)delegateQueue;
 
-/// @brief Configurable TLS options. Use this if you wants TLS on a port other than 443.
+/*!
+ * @brief Configurable TLS options. Use this if you wants TLS on a port other than 443.
+ * @param uri        The URI contains all connection information, including credentials.<br/>
+                     For example, "amqps://user:pass@hostname:1234/myvhost".<br/>
+                     Note: to use the default "/" vhost, omit the trailing slash (or else you must encode it as %2F).
+ * @param tlsOptions The RMQTLSOptions to use
+ * @param delegate   Any object that conforms to the RMQConnectionDelegate protocol.
+                     Use this to handle connection- and  channel-level errors.
+                     RMQConnectionDelegateLogger is useful for development purposes.
+ */
 - (nonnull instancetype)initWithUri:(nonnull NSString *)uri
                          tlsOptions:(nonnull RMQTLSOptions *)tlsOptions
                            delegate:(nullable id<RMQConnectionDelegate>)delegate;
 
-/// @brief Parses URI to obtain credentials and TLS, customisable peer verification.
+/*!
+ * @brief Parses URI to obtain credentials and TLS, customisable peer verification.
+ * @param uri        The URI contains all connection information, including credentials.<br/>
+                     For example, "amqps://user:pass@hostname:1234/myvhost".<br/>
+                     Note: to use the default "/" vhost, omit the trailing slash (or else you must encode it as %2F).
+ * @param verifyPeer Set to NO / false when developing against servers without valid certificates.
+                     Never set this to NO / false in production.
+ * @param delegate   Any object that conforms to the RMQConnectionDelegate protocol.
+                     Use this to handle connection- and  channel-level errors.
+                     RMQConnectionDelegateLogger is useful for development purposes.
+ */
 - (nonnull instancetype)initWithUri:(nonnull NSString *)uri
                          verifyPeer:(BOOL)verifyPeer
                            delegate:(nullable id<RMQConnectionDelegate>)delegate;
 
-/// @brief Parses URI to obtain credentials and TLS enablement (which implies verifyPeer).
+/*!
+ * @brief Parses URI to obtain credentials and TLS enablement (which implies verifyPeer).
+ * @param uri        The URI contains all connection information, including credentials.<br/>
+                     For example, "amqps://user:pass@hostname:1234/myvhost".<br/>
+                     Note: to use the default "/" vhost, omit the trailing slash (or else you must encode it as %2F).
+ * @param delegate   Any object that conforms to the RMQConnectionDelegate protocol.
+                     Use this to handle connection- and  channel-level errors.
+                     RMQConnectionDelegateLogger is useful for development purposes.
+ */
 - (nonnull instancetype)initWithUri:(nonnull NSString *)uri
                            delegate:(nullable id<RMQConnectionDelegate>)delegate;