Merge branch 'release/2.1.2'

Fixes #17

.jazzy.yaml

@@ -1,5 +1,5 @@
 module: HTMLKit
-module_version: 2.1.1
+module_version: 2.1.2
 author: Iskandar Abudiab 
 author_url: https://twitter.com/iabudiab
 github_url: https://github.com/iabudiab/HTMLKit

CHANGELOG.md

@@ -1,5 +1,15 @@
 # Change Log
 
+## [2.1.2](https://github.com/iabudiab/HTMLKit/releases/tag/2.1.2) 
+
+Released on 2017.11.6
+
+### Fixes
+
+- `HTMLText` serialization (issue #16)
+- `HTMLElement` attribute value serialization (issue #17)
+
+
 ## [2.1.1](https://github.com/iabudiab/HTMLKit/releases/tag/2.1.1) 
 
 Released on 2017.10.13

HTMLKit.podspec

@@ -1,6 +1,6 @@
 Pod::Spec.new do |s|
   s.name               = "HTMLKit"
-  s.version            = "2.1.1"
+  s.version            = "2.1.2"
   s.summary            = "HTMLKit, an Objective-C framework for your everyday HTML needs."
   s.license            = "MIT"
   s.homepage           = "https://github.com/iabudiab/HTMLKit"

HTMLKit.xcodeproj/project.pbxproj

@@ -306,6 +306,9 @@
 		62857D8F1D39A47F008DC254 /* CSSCombinatorSelector.h in Headers */ = {isa = PBXBuildFile; fileRef = 62FA04E11BCC360D009ABF98 /* CSSCombinatorSelector.h */; settings = {ATTRIBUTES = (Public, ); }; };
 		62857D901D39A47F008DC254 /* CSSCompoundSelector.h in Headers */ = {isa = PBXBuildFile; fileRef = 620C87791BD44CBE00FB3EEE /* CSSCompoundSelector.h */; settings = {ATTRIBUTES = (Public, ); }; };
 		628AF6301BC99A6C00496128 /* CSSNthExpressionsParserTests.m in Sources */ = {isa = PBXBuildFile; fileRef = 628AF62E1BC99A6C00496128 /* CSSNthExpressionsParserTests.m */; };
+		62A95A4D1FB0FBFC0009FF26 /* HTMLSerializationTests.m in Sources */ = {isa = PBXBuildFile; fileRef = 62A95A4C1FB0FBFC0009FF26 /* HTMLSerializationTests.m */; };
+		62A95A4E1FB0FBFC0009FF26 /* HTMLSerializationTests.m in Sources */ = {isa = PBXBuildFile; fileRef = 62A95A4C1FB0FBFC0009FF26 /* HTMLSerializationTests.m */; };
+		62A95A4F1FB0FBFC0009FF26 /* HTMLSerializationTests.m in Sources */ = {isa = PBXBuildFile; fileRef = 62A95A4C1FB0FBFC0009FF26 /* HTMLSerializationTests.m */; };
 		62D8345A19FB1AC4009205A9 /* HTML5LibTokenizerTest.m in Sources */ = {isa = PBXBuildFile; fileRef = 62D8345819FB1AC4009205A9 /* HTML5LibTokenizerTest.m */; };
 		62D91C231DE218A500BEFADE /* HTMLRange.h in Headers */ = {isa = PBXBuildFile; fileRef = 62D91C211DE218A500BEFADE /* HTMLRange.h */; settings = {ATTRIBUTES = (Public, ); }; };
 		62D91C241DE218A500BEFADE /* HTMLRange.h in Headers */ = {isa = PBXBuildFile; fileRef = 62D91C211DE218A500BEFADE /* HTMLRange.h */; settings = {ATTRIBUTES = (Public, ); }; };
@@ -703,6 +706,7 @@
 		628AF63C1BC9D6FB00496128 /* CSSStructuralPseudoSelectors.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; name = CSSStructuralPseudoSelectors.h; path = include/CSSStructuralPseudoSelectors.h; sourceTree = "<group>"; };
 		628AF63D1BC9D6FB00496128 /* CSSStructuralPseudoSelectors.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; path = CSSStructuralPseudoSelectors.m; sourceTree = "<group>"; };
 		628B7CE61A080E1000602C87 /* HTMLNamespaces.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; name = HTMLNamespaces.h; path = include/HTMLNamespaces.h; sourceTree = "<group>"; };
+		62A95A4C1FB0FBFC0009FF26 /* HTMLSerializationTests.m */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.objc; name = HTMLSerializationTests.m; path = HTMLKitTests/HTMLSerializationTests.m; sourceTree = "<group>"; };
 		62ACB8DB1BC5C13E00E283C1 /* CSSPseudoFunctionSelector.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; name = CSSPseudoFunctionSelector.h; path = include/CSSPseudoFunctionSelector.h; sourceTree = "<group>"; };
 		62ACB8DC1BC5C13E00E283C1 /* CSSPseudoFunctionSelector.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; path = CSSPseudoFunctionSelector.m; sourceTree = "<group>"; };
 		62AE593319F97D880043F069 /* HTMLParseErrorToken.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; name = HTMLParseErrorToken.h; path = include/HTMLParseErrorToken.h; sourceTree = "<group>"; };
@@ -885,6 +889,7 @@
 				62EC7AE51AEEAC6F0015D3BE /* HTMLMutationAlgorithmsTests.m */,
 				62EC0A841E158BD80007786B /* HTMLRangeTests.m */,
 				62E0BA961E25456700E4D193 /* HTMLCharacterDataTests.m */,
+				62A95A4C1FB0FBFC0009FF26 /* HTMLSerializationTests.m */,
 			);
 			name = DOM;
 			sourceTree = "<group>";
@@ -1761,6 +1766,7 @@
 				62567F561C0CC3AE0025D458 /* HTMLDOMTokenListTests.m in Sources */,
 				624AC90219FBF9ED00BD3C4A /* HTMLKitTokenizerTests.m in Sources */,
 				624B9FB31AE0313300646C4C /* HTMLStringCategoryTests.m in Sources */,
+				62A95A4D1FB0FBFC0009FF26 /* HTMLSerializationTests.m in Sources */,
 				623916C81AC7209E0066B4FE /* HTMLNodeIteratorTests.m in Sources */,
 				62D8345A19FB1AC4009205A9 /* HTML5LibTokenizerTest.m in Sources */,
 				6239755F1AC364BB007E26F1 /* HTML5LibTreeConstructionTest.m in Sources */,
@@ -1903,6 +1909,7 @@
 				62857D401D39A345008DC254 /* CSSAttributeSelectorTests.m in Sources */,
 				62857D311D39A33C008DC254 /* HTML5LibTreeConstructionTest.m in Sources */,
 				62857D391D39A342008DC254 /* HTMLOrderedDictionaryTests.m in Sources */,
+				62A95A4F1FB0FBFC0009FF26 /* HTMLSerializationTests.m in Sources */,
 				62857D411D39A345008DC254 /* CSSNThExpressionSelectorTests.m in Sources */,
 				62857D381D39A342008DC254 /* HTMLStringCategoryTests.m in Sources */,
 				62857D331D39A33C008DC254 /* HTMLKitParserPerformance.m in Sources */,
@@ -1990,6 +1997,7 @@
 				62567F571C0CC3AE0025D458 /* HTMLDOMTokenListTests.m in Sources */,
 				62ECBFD41C0B6E2E00AF847B /* HTMLStringCategoryTests.m in Sources */,
 				62ECBFD51C0B6E2E00AF847B /* HTMLOrderedDictionaryTests.m in Sources */,
+				62A95A4E1FB0FBFC0009FF26 /* HTMLSerializationTests.m in Sources */,
 				62ECBFD61C0B6E2E00AF847B /* CSSSelectorTest.m in Sources */,
 				62ECBFD71C0B6E2E00AF847B /* CSSSelectorParserTests.m in Sources */,
 				62ECBFD81C0B6E2E00AF847B /* CSSNthExpressionsParserTests.m in Sources */,
@@ -2118,6 +2126,7 @@
 		625A14D519C7829400AD0C32 /* Debug */ = {
 			isa = XCBuildConfiguration;
 			buildSettings = {
+				CLANG_WARN_DOCUMENTATION_COMMENTS = YES;
 				COMBINE_HIDPI_IMAGES = YES;
 				DEFINES_MODULE = YES;
 				DYLIB_COMPATIBILITY_VERSION = 1;
@@ -2127,8 +2136,10 @@
 				FRAMEWORK_VERSION = A;
 				GCC_PRECOMPILE_PREFIX_HEADER = YES;
 				GCC_PREFIX_HEADER = "";
+				GCC_TREAT_IMPLICIT_FUNCTION_DECLARATIONS_AS_ERRORS = YES;
 				GCC_TREAT_INCOMPATIBLE_POINTER_TYPE_WARNINGS_AS_ERRORS = YES;
 				GCC_TREAT_WARNINGS_AS_ERRORS = YES;
+				GCC_WARN_ABOUT_MISSING_PROTOTYPES = YES;
 				INFOPLIST_FILE = "Sources/HTMLKit-Info.plist";
 				INSTALL_PATH = "@rpath";
 				IPHONEOS_DEPLOYMENT_TARGET = 8.0;
@@ -2143,6 +2154,7 @@
 		625A14D619C7829400AD0C32 /* Release */ = {
 			isa = XCBuildConfiguration;
 			buildSettings = {
+				CLANG_WARN_DOCUMENTATION_COMMENTS = YES;
 				COMBINE_HIDPI_IMAGES = YES;
 				DEFINES_MODULE = YES;
 				DYLIB_COMPATIBILITY_VERSION = 1;
@@ -2152,8 +2164,10 @@
 				FRAMEWORK_VERSION = A;
 				GCC_PRECOMPILE_PREFIX_HEADER = YES;
 				GCC_PREFIX_HEADER = "";
+				GCC_TREAT_IMPLICIT_FUNCTION_DECLARATIONS_AS_ERRORS = YES;
 				GCC_TREAT_INCOMPATIBLE_POINTER_TYPE_WARNINGS_AS_ERRORS = YES;
 				GCC_TREAT_WARNINGS_AS_ERRORS = YES;
+				GCC_WARN_ABOUT_MISSING_PROTOTYPES = YES;
 				INFOPLIST_FILE = "Sources/HTMLKit-Info.plist";
 				INSTALL_PATH = "@rpath";
 				IPHONEOS_DEPLOYMENT_TARGET = 8.0;
@@ -2218,6 +2232,7 @@
 			buildSettings = {
 				APPLICATION_EXTENSION_API_ONLY = YES;
 				CLANG_ANALYZER_NONNULL = YES;
+				CLANG_WARN_DOCUMENTATION_COMMENTS = YES;
 				CLANG_WARN_UNREACHABLE_CODE = YES;
 				"CODE_SIGN_IDENTITY[sdk=watchos*]" = "";
 				CURRENT_PROJECT_VERSION = 1;
@@ -2229,7 +2244,9 @@
 				ENABLE_STRICT_OBJC_MSGSEND = YES;
 				GCC_NO_COMMON_BLOCKS = YES;
 				GCC_PREFIX_HEADER = "";
+				GCC_TREAT_IMPLICIT_FUNCTION_DECLARATIONS_AS_ERRORS = YES;
 				GCC_TREAT_WARNINGS_AS_ERRORS = YES;
+				GCC_WARN_ABOUT_MISSING_PROTOTYPES = YES;
 				INFOPLIST_FILE = "Sources/HTMLKit-Info.plist";
 				INSTALL_PATH = "$(LOCAL_LIBRARY_DIR)/Frameworks";
 				IPHONEOS_DEPLOYMENT_TARGET = 8.0;
@@ -2253,6 +2270,7 @@
 			buildSettings = {
 				APPLICATION_EXTENSION_API_ONLY = YES;
 				CLANG_ANALYZER_NONNULL = YES;
+				CLANG_WARN_DOCUMENTATION_COMMENTS = YES;
 				CLANG_WARN_UNREACHABLE_CODE = YES;
 				"CODE_SIGN_IDENTITY[sdk=watchos*]" = "";
 				COPY_PHASE_STRIP = NO;
@@ -2264,7 +2282,9 @@
 				ENABLE_STRICT_OBJC_MSGSEND = YES;
 				GCC_NO_COMMON_BLOCKS = YES;
 				GCC_PREFIX_HEADER = "";
+				GCC_TREAT_IMPLICIT_FUNCTION_DECLARATIONS_AS_ERRORS = YES;
 				GCC_TREAT_WARNINGS_AS_ERRORS = YES;
+				GCC_WARN_ABOUT_MISSING_PROTOTYPES = YES;
 				INFOPLIST_FILE = "Sources/HTMLKit-Info.plist";
 				INSTALL_PATH = "$(LOCAL_LIBRARY_DIR)/Frameworks";
 				IPHONEOS_DEPLOYMENT_TARGET = 8.0;
@@ -2288,6 +2308,7 @@
 			isa = XCBuildConfiguration;
 			buildSettings = {
 				CLANG_ANALYZER_NONNULL = YES;
+				CLANG_WARN_DOCUMENTATION_COMMENTS = YES;
 				CLANG_WARN_UNREACHABLE_CODE = YES;
 				CODE_SIGN_IDENTITY = "";
 				"CODE_SIGN_IDENTITY[sdk=*]" = "iPhone Developer";
@@ -2301,7 +2322,9 @@
 				ENABLE_STRICT_OBJC_MSGSEND = YES;
 				GCC_NO_COMMON_BLOCKS = YES;
 				GCC_PREFIX_HEADER = "";
+				GCC_TREAT_IMPLICIT_FUNCTION_DECLARATIONS_AS_ERRORS = YES;
 				GCC_TREAT_WARNINGS_AS_ERRORS = YES;
+				GCC_WARN_ABOUT_MISSING_PROTOTYPES = YES;
 				INFOPLIST_FILE = "Sources/HTMLKit-Info.plist";
 				INSTALL_PATH = "$(LOCAL_LIBRARY_DIR)/Frameworks";
 				IPHONEOS_DEPLOYMENT_TARGET = 8.0;
@@ -2323,6 +2346,7 @@
 			isa = XCBuildConfiguration;
 			buildSettings = {
 				CLANG_ANALYZER_NONNULL = YES;
+				CLANG_WARN_DOCUMENTATION_COMMENTS = YES;
 				CLANG_WARN_UNREACHABLE_CODE = YES;
 				CODE_SIGN_IDENTITY = "";
 				"CODE_SIGN_IDENTITY[sdk=*]" = "iPhone Developer";
@@ -2336,7 +2360,9 @@
 				ENABLE_STRICT_OBJC_MSGSEND = YES;
 				GCC_NO_COMMON_BLOCKS = YES;
 				GCC_PREFIX_HEADER = "";
+				GCC_TREAT_IMPLICIT_FUNCTION_DECLARATIONS_AS_ERRORS = YES;
 				GCC_TREAT_WARNINGS_AS_ERRORS = YES;
+				GCC_WARN_ABOUT_MISSING_PROTOTYPES = YES;
 				INFOPLIST_FILE = "Sources/HTMLKit-Info.plist";
 				INSTALL_PATH = "$(LOCAL_LIBRARY_DIR)/Frameworks";
 				IPHONEOS_DEPLOYMENT_TARGET = 8.0;
@@ -2399,6 +2425,7 @@
 		62ECBF5F1C0B6C7600AF847B /* Debug */ = {
 			isa = XCBuildConfiguration;
 			buildSettings = {
+				CLANG_WARN_DOCUMENTATION_COMMENTS = YES;
 				CLANG_WARN_UNREACHABLE_CODE = YES;
 				CODE_SIGN_IDENTITY = "";
 				"CODE_SIGN_IDENTITY[sdk=iphoneos*]" = "";
@@ -2411,8 +2438,10 @@
 				ENABLE_STRICT_OBJC_MSGSEND = YES;
 				GCC_NO_COMMON_BLOCKS = YES;
 				GCC_PREFIX_HEADER = "";
+				GCC_TREAT_IMPLICIT_FUNCTION_DECLARATIONS_AS_ERRORS = YES;
 				GCC_TREAT_INCOMPATIBLE_POINTER_TYPE_WARNINGS_AS_ERRORS = YES;
 				GCC_TREAT_WARNINGS_AS_ERRORS = YES;
+				GCC_WARN_ABOUT_MISSING_PROTOTYPES = YES;
 				GCC_WARN_INHIBIT_ALL_WARNINGS = NO;
 				GCC_WARN_PEDANTIC = NO;
 				INFOPLIST_FILE = "Sources/HTMLKit-Info.plist";
@@ -2435,6 +2464,7 @@
 		62ECBF601C0B6C7600AF847B /* Release */ = {
 			isa = XCBuildConfiguration;
 			buildSettings = {
+				CLANG_WARN_DOCUMENTATION_COMMENTS = YES;
 				CLANG_WARN_UNREACHABLE_CODE = YES;
 				CODE_SIGN_IDENTITY = "";
 				"CODE_SIGN_IDENTITY[sdk=iphoneos*]" = "";
@@ -2447,8 +2477,10 @@
 				ENABLE_STRICT_OBJC_MSGSEND = YES;
 				GCC_NO_COMMON_BLOCKS = YES;
 				GCC_PREFIX_HEADER = "";
+				GCC_TREAT_IMPLICIT_FUNCTION_DECLARATIONS_AS_ERRORS = YES;
 				GCC_TREAT_INCOMPATIBLE_POINTER_TYPE_WARNINGS_AS_ERRORS = YES;
 				GCC_TREAT_WARNINGS_AS_ERRORS = YES;
+				GCC_WARN_ABOUT_MISSING_PROTOTYPES = YES;
 				GCC_WARN_INHIBIT_ALL_WARNINGS = NO;
 				GCC_WARN_PEDANTIC = NO;
 				INFOPLIST_FILE = "Sources/HTMLKit-Info.plist";

README.md

@@ -4,8 +4,8 @@
 
 An Objective-C framework for your everyday HTML needs.
 
-[![Build Status](https://img.shields.io/travis/iabudiab/HTMLKit/master.svg?style=flat)](https://travis-ci.org/iabudiab/HTMLKit)
-[![codecov](https://codecov.io/gh/iabudiab/HTMLKit/branch/master/graph/badge.svg)](https://codecov.io/gh/iabudiab/HTMLKit)
+[![Build Status](https://img.shields.io/travis/iabudiab/HTMLKit/develop.svg?style=flat)](https://travis-ci.org/iabudiab/HTMLKit)
+[![codecov](https://codecov.io/gh/iabudiab/HTMLKit/branch/develop/graph/badge.svg)](https://codecov.io/gh/iabudiab/HTMLKit)
 [![Carthage Compatible](https://img.shields.io/badge/Carthage-compatible-4BC51D.svg?style=flat)](https://github.com/Carthage/Carthage)
 [![CocoaPods Compatible](https://img.shields.io/cocoapods/v/HTMLKit.svg?style=flat)](https://cocoapods.org/pods/HTMLKit)
 [![CocoaDocs](https://img.shields.io/cocoapods/metrics/doc-percent/HTMLKit.svg?style=flat)](http://cocoadocs.org/docsets/HTMLKit)

Sources/CSSNthExpressionSelector.m

@@ -38,7 +38,7 @@ NSString * _Nonnull NSStringFromNthExpression(CSSNthExpression expression)
 
 #pragma mark - Implementation
 
-NSInteger computeIndex(NSEnumerator *enumerator, HTMLElement *element)
+NS_INLINE NSInteger computeIndex(NSEnumerator *enumerator, HTMLElement *element)
 {
 	NSInteger index = 0;
 	for (HTMLNode *node in enumerator) {

Sources/HTMLElement.m

@@ -157,11 +157,10 @@
 
 	[result appendFormat:@"<%@", self.tagName];
 	[self.attributes enumerateKeysAndObjectsUsingBlock:^(NSString *key, NSString *value, BOOL *stop) {
-		NSRange range = NSMakeRange(0, value.length);
 		NSMutableString *escaped = [value mutableCopy];
-		[escaped replaceOccurrencesOfString:@"&" withString:@"&amp;" options:0 range:range];
-		[escaped replaceOccurrencesOfString:@"\00A0" withString:@"&nbsp;" options:0 range:range];
-		[escaped replaceOccurrencesOfString:@"\"" withString:@"&quot;" options:0 range:range];
+		[escaped replaceOccurrencesOfString:@"&" withString:@"&amp;" options:0 range:NSMakeRange(0, escaped.length)];
+		[escaped replaceOccurrencesOfString:@"0x00A0" withString:@"&nbsp;" options:0 range:NSMakeRange(0, escaped.length)];
+		[escaped replaceOccurrencesOfString:@"\"" withString:@"&quot;" options:0 range:NSMakeRange(0, escaped.length)];
 
 		[result appendFormat:@" %@=\"%@\"", key, escaped];
 	}];

Sources/HTMLKit-Info.plist

@@ -17,7 +17,7 @@
 	<key>CFBundlePackageType</key>
 	<string>FMWK</string>
 	<key>CFBundleShortVersionString</key>
-	<string>2.1.1</string>
+	<string>2.1.2</string>
 	<key>CFBundleSignature</key>
 	<string>????</string>
 	<key>CFBundleVersion</key>

Sources/HTMLText.m

@@ -74,12 +74,11 @@ NS_INLINE void CheckValidOffset(HTMLNode *node, NSUInteger offset, NSString *cmd
 		 @"plaintext", @"noscript", nil]) {
 		return self.data;
 	} else {
-		NSRange range = NSMakeRange(0, self.data.length);
 		NSMutableString *escaped = [self.data mutableCopy];
-		[escaped replaceOccurrencesOfString:@"&" withString:@"&" options:0 range:range];
-		[escaped replaceOccurrencesOfString:@"\00A0" withString:@" " options:0 range:range];
-		[escaped replaceOccurrencesOfString:@"<" withString:@"&lt;" options:0 range:range];
-		[escaped replaceOccurrencesOfString:@">" withString:@"&gt;" options:0 range:range];
+		[escaped replaceOccurrencesOfString:@"&" withString:@"&amp;" options:0 range:NSMakeRange(0, escaped.length)];
+		[escaped replaceOccurrencesOfString:@"\00A0" withString:@"&nbsp;" options:0 range:NSMakeRange(0, escaped.length)];
+		[escaped replaceOccurrencesOfString:@"<" withString:@"&lt;" options:0 range:NSMakeRange(0, escaped.length)];
+		[escaped replaceOccurrencesOfString:@">" withString:@"&gt;" options:0 range:NSMakeRange(0, escaped.length)];
 		return escaped;
 	}
 }

Sources/include/CSSPseudoFunctionSelector.h

@@ -26,7 +26,7 @@ NS_ASSUME_NONNULL_BEGIN
 /**
  Initializes and returns a CSS has-descendant selector, e.g. 'div:has(p)'
 
- @discussion 'div:has(p)' matches all <div> elements which have a descendant <p> element.
+ @discussion 'div:has(p)' matches all &lt;div&gt; elements which have a descendant &lt;p&gt; element.
 
  @param selector The selector matching a descendant element.
  @return A new instance of the has-descendant selector.

Sources/include/CSSSelector.h

@@ -76,7 +76,7 @@ extern NSString * _Nonnull NSStringFromNthExpression(CSSNthExpression expression
  @param string The selector string which will be parsed.
  @return A new instance of a parsed CSS Selector, `nil` if the string is not a valid selector string.
  */
-+ (nullable instancetype)selectorWithString:(NSString *)stirng;
++ (nullable instancetype)selectorWithString:(NSString *)string;
 
 /**
  Implementations should override this method to provide the selector-sprecific logic for matching elements.

Sources/include/CSSSelectors.h

@@ -225,7 +225,7 @@ extern CSSSelector * not(CSSSelector *selector);
 /**
  CSS has-descendant selector, e.g. 'div:has(p)'
 
- @discussion 'div:has(p)' matches all <div> elements which have a descendant <p> element.
+ @discussion 'div:has(p)' matches all &lt;div&gt; elements which have a descendant &lt;p&gt; element.
 
  @param selector The selector matching a descendant element.
  @return A has-descendant selector.

Sources/include/HTMLCommentToken.h

@@ -24,7 +24,7 @@
 /**
  Initializes a new comment token.
 
- @param string The string with which to initialize the token.
+ @param data The string with which to initialize the token.
  @return A new instance of a comment token.
  */
 - (instancetype)initWithData:(NSString *)data;

Sources/include/HTMLElement.h

@@ -63,7 +63,7 @@ NS_ASSUME_NONNULL_BEGIN
 /**
  Initializes a new HTML element with the given tag name.
  
- @param tagname The tag name.
+ @param tagName The tag name.
  @return A new HTML element.
  */
 - (instancetype)initWithTagName:(NSString *)tagName;
@@ -71,7 +71,7 @@ NS_ASSUME_NONNULL_BEGIN
 /**
  Initializes a new HTML element with the given tag name and attributes.
 
- @param tagname The tag name.
+ @param tagName The tag name.
  @param attributes The attributes.
  @return A new HTML element.
  */
@@ -80,8 +80,8 @@ NS_ASSUME_NONNULL_BEGIN
 /**
  Initializes a new HTML element with the given tag name, namespace, and attributes.
 
- @param tagname The tag name.
- @param namespace The namespace.
+ @param tagName The tag name.
+ @param htmlNamespace The HTML namespace.
  @param attributes The attributes.
  @return A new HTML element.
  */
@@ -107,7 +107,7 @@ NS_ASSUME_NONNULL_BEGIN
  Set the value of the attribute with the given name.
 
  @param value The value to set.
- @param name The attribute's name.
+ @param attribute The attribute's name.
  */
 - (void)setObject:(NSString *)value forKeyedSubscript:(NSString *)attribute;
 

Sources/include/HTMLInputStreamReader.h

@@ -15,7 +15,8 @@
 /** 
  Typedef for the error callback block.
 
- @param reason The string describing the reason of the reported error.
+ @param code The standarized error-code
+ @param details The string describing the reason of the reported error.
  */
 typedef void (^ HTMLStreamReaderErrorCallback)(NSString *code, NSString *details);
 

Sources/include/HTMLNode.h

@@ -232,7 +232,7 @@ typedef NS_OPTIONS(unsigned short, HTMLDocumentPosition)
 /**
  Returns the index of the given child element in the set of child nodes.
 
- @param node The element.
+ @param element The element.
  @return The index of the given element in the children set.
  */
 - (NSUInteger)indexOfChildElement:(HTMLElement *)element;
@@ -248,7 +248,7 @@ typedef NS_OPTIONS(unsigned short, HTMLDocumentPosition)
 /**
  Prepends the given array of nodes to the set of child nodes.
 
- @param node The nodes to prepend.
+ @param nodes The nodes to prepend.
  */
 - (void)prependNodes:(NSArray<HTMLNode *> *)nodes;
 

Sources/include/HTMLRange.h

@@ -113,16 +113,16 @@ typedef NS_ENUM(unsigned short, HTMLRangeComparisonMethod)
 /**
  Sets the start boundary.
 
- @param startNode The new node of the start boundary.
- @param startOffset The new offset of the start boundary.
+ @param node The new node of the start boundary.
+ @param offset The new offset of the start boundary.
  */
 - (void)setStartNode:(HTMLNode *)node startOffset:(NSUInteger)offset;
 
 /**
  Sets the end boundary.
 
- @param startNode The new node of the end boundary.
- @param startOffset The new offset of the end boundary.
+ @param node The new node of the end boundary.
+ @param offset The new offset of the end boundary.
  */
 - (void)setEndNode:(HTMLNode *)node endOffset:(NSUInteger)offset;
 

Sources/include/HTMLStackOfOpenElements.h

@@ -79,7 +79,7 @@
 /**
  Checks whether an element with the given tag name is in the stack.
 
- @param tagname The element's tag name.
+ @param tagName The element's tag name.
  @return `YES` if such an element is in the stack, `NO` otherwise.
  */
 - (BOOL)containsElementWithTagName:(NSString *)tagName;

Sources/include/HTMLTreeWalker.h

@@ -49,7 +49,6 @@ NS_ASSUME_NONNULL_BEGIN
  Initializes a new tree walker with no filter and HTMLNodeFilterShowAll show options.
 
  @param node The root node.
- @param filter The node filter to use.
  @return A new instance of a tree walker.
  */
 - (instancetype)initWithNode:(HTMLNode *)node;

Tests/HTMLKitTests/HTMLSerializationTests.m

@@ -0,0 +1,44 @@
+//
+//  HTMLSerializationTests.m
+//  HTMLKit
+//
+//  Created by Iska on 06.11.17.
+//  Copyright © 2017 BrainCookie. All rights reserved.
+//
+
+#import <XCTest/XCTest.h>
+#import "HTMLDOM.h"
+
+@interface HTMLSerializationTests : XCTestCase
+
+@end
+
+@implementation HTMLSerializationTests
+
+- (void)setUp {
+    [super setUp];
+}
+
+- (void)tearDown {
+    [super tearDown];
+}
+
+#pragma mark - Bug Fixes
+
+- (void)testBugFix_Issue_16
+{
+	NSString *html = @"<body><div>&lt;test&gt;</div></body>";
+	HTMLDocument *document = [HTMLDocument documentWithString:html];
+
+	XCTAssertEqualObjects(document.body.outerHTML, html);
+}
+
+- (void)testBugFix_Issue_17
+{
+	NSString *html = @"<body key='& testing 0x00A0'></body>";
+	HTMLDocument *document = [HTMLDocument documentWithString:html];
+
+	XCTAssertEqualObjects(document.body.outerHTML, @"<body key=\"&amp; testing &nbsp;\"></body>");
+}
+
+@end