[Issue Alamofire#464] Documenting requirements for URLString type

confile · May 2, 2015 · eb4a945 · eb4a945
1 parent bc6fa4c
commit eb4a945
Showing 1 changed file with 9 additions and 1 deletion.
diff --git a/Source/Alamofire.swift b/Source/Alamofire.swift
@@ -164,7 +164,15 @@ public enum ParameterEncoding {
     Types adopting the `URLStringConvertible` protocol can be used to construct URL strings, which are then used to construct URL requests.
 */
 public protocol URLStringConvertible {
-    /// The URL string.
+    /** 
+        A URL that conforms to RFC 2396.
+
+        Methods accepting a `URLStringConvertible` type parameter parse it according to RFCs 1738 and 1808.
+
+        See http://tools.ietf.org/html/rfc2396
+        See http://tools.ietf.org/html/rfc1738
+        See http://tools.ietf.org/html/rfc1808
+    */
     var URLString: String { get }
 }