improve documentation

adela-chang · adela-chang · commit 7977aff7e1fe · 2016-02-16T10:42:49.000-08:00
diff --git a/Pod/Classes/HTMLEntityMapping.swift b/Pod/Classes/HTMLEntityMapping.swift
@@ -7,10 +7,10 @@
 
 import Foundation
 
-// Very slightly adapted from http://stackoverflow.com/a/30141700/106244 
-// 99.99% Credit to Martin R!
-// Mapping from XML/HTML character entity reference to character
-// From http://en.wikipedia.org/wiki/List_of_XML_and_HTML_character_entity_references
+/** 
+    Mapping from XML/HTML character entity reference to character
+    From http://en.wikipedia.org/wiki/List_of_XML_and_HTML_character_entity_references
+*/
 public let characterEntities : [String: Character] = [
     // XML predefined entities:
     "&quot;"     : "\"",
diff --git a/Pod/Classes/StringExtensionHTML.swift b/Pod/Classes/StringExtensionHTML.swift
@@ -1,7 +1,11 @@
 import Foundation
 
+/// A string extension which provides easy functionality to decode
+/// HTML entities.
 extension String {
     
+    /// Returns a new string made by removing in the `String`
+    /// anything enclosed in HTML brackets <>
     public var stringByStrippingHTMLTags: String {
         return stringByReplacingOccurrencesOfString("<[^>]+>", withString: "", options: .RegularExpressionSearch, range: nil);
     }
diff --git a/StringExtensionHTML.podspec b/StringExtensionHTML.podspec
@@ -8,7 +8,7 @@
 
 Pod::Spec.new do |s|
   s.name             = "StringExtensionHTML"
-  s.version          = "0.1.2"
+  s.version          = "0.1.3"
   s.summary          = "Extends the native Swift string with a method to easily decode HTML entities."
 
 # This description is used to generate tags and improve search results.
