#33 Documented Core/

GCDWebServer/Core/GCDWebServerFunctions.h

@@ -31,14 +31,68 @@
 extern "C" {
 #endif
 
+/**
+ *  Converts a file extension to the corresponding MIME type.
+ *  If there is no match, "application/octet-stream" is returned.
+ */
 NSString* GCDWebServerGetMimeTypeForExtension(NSString* extension);
+
+/**
+ *  Add percent-escapes to a string so it can be used in a URL.
+ *  The legal characters ":@/?&=+" are also escaped to ensure compatibility
+ *  with URL encoded forms and URL queries.
+ */
 NSString* GCDWebServerEscapeURLString(NSString* string);
+
+/**
+ *  Unescapes a URL percent-encoded string.
+ */
 NSString* GCDWebServerUnescapeURLString(NSString* string);
+
+/**
+ *  Extracts the unescaped names and values
+ *  from a "application/x-www-form-urlencoded" form.
+ *  http://www.w3.org/TR/html401/interact/forms.html#h-17.13.4.1
+ */
 NSDictionary* GCDWebServerParseURLEncodedForm(NSString* form);
-NSString* GCDWebServerGetPrimaryIPv4Address();  // Returns IPv4 address of primary connected service on OS X or of WiFi interface on iOS if connected
+
+/**
+ *  OS X: Returns the IPv4 address as a dotted string of the primary connected
+ *        service or nil if not available.
+ *  iOS: Returns the IPv4 address as a dotted string of the WiFi interface
+ *       if connected or nil otherwise.
+ */
+NSString* GCDWebServerGetPrimaryIPv4Address();
+
+/**
+ *  Converts a date into a string using RFC822 formatting.
+ *  https://tools.ietf.org/html/rfc822#section-5
+ *  https://tools.ietf.org/html/rfc1123#section-5.2.14
+ */
 NSString* GCDWebServerFormatRFC822(NSDate* date);
+
+/**
+ *  Converts a RFC822 formatted string into a date.
+ *  https://tools.ietf.org/html/rfc822#section-5
+ *  https://tools.ietf.org/html/rfc1123#section-5.2.14
+ *
+ *  @warning Timezones are not supported at this time.
+ */
 NSDate* GCDWebServerParseRFC822(NSString* string);
+
+/**
+ *  Converts a date into a string using IOS 8601 formatting.
+ *  http://tools.ietf.org/html/rfc3339#section-5.6
+ */
 NSString* GCDWebServerFormatISO8601(NSDate* date);
+
+/**
+ *  Converts a ISO 8601 formatted string into a date.
+ *  http://tools.ietf.org/html/rfc3339#section-5.6
+ *
+ *  @warning Only "calendar" variant is supported at this time and timezones
+ *  are not supported either.
+ */
 NSDate* GCDWebServerParseISO8601(NSString* string);
 
 #ifdef __cplusplus