Skip to content

Commit

Permalink
Set lower deployment targets; update README
Browse files Browse the repository at this point in the history
  • Loading branch information
@youming-lin
youming-lin committed Sep 8, 2017
1 parent eab2e39 commit e51f2ab
Show file tree
Hide file tree
Showing 18 changed files with 253 additions and 88 deletions.
10 changes: 8 additions & 2 deletions HTMLEntities-Carthage.xcodeproj/project.pbxproj
View file
Original file line number Diff line number Diff line change
Expand Up @@ -262,7 +262,8 @@
DYLIB_INSTALL_NAME_BASE = "@rpath";
ENABLE_NS_ASSERTIONS = YES;
GCC_OPTIMIZATION_LEVEL = 0;
MACOSX_DEPLOYMENT_TARGET = 10.10;
IPHONEOS_DEPLOYMENT_TARGET = 8.0;
MACOSX_DEPLOYMENT_TARGET = 10.9;
ONLY_ACTIVE_ARCH = YES;
OTHER_SWIFT_FLAGS = "-DXcode";
PRODUCT_NAME = "$(TARGET_NAME)";
Expand All @@ -271,7 +272,9 @@
SWIFT_ACTIVE_COMPILATION_CONDITIONS = SWIFT_PACKAGE;
SWIFT_OPTIMIZATION_LEVEL = "-Onone";
SWIFT_VERSION = 3.0;
TVOS_DEPLOYMENT_TARGET = 9.0;
USE_HEADERMAP = NO;
WATCHOS_DEPLOYMENT_TARGET = 2.0;
};
name = Debug;
};
Expand Down Expand Up @@ -318,15 +321,18 @@
DEBUG_INFORMATION_FORMAT = "dwarf-with-dsym";
DYLIB_INSTALL_NAME_BASE = "@rpath";
GCC_OPTIMIZATION_LEVEL = s;
MACOSX_DEPLOYMENT_TARGET = 10.10;
IPHONEOS_DEPLOYMENT_TARGET = 8.0;
MACOSX_DEPLOYMENT_TARGET = 10.9;
OTHER_SWIFT_FLAGS = "-DXcode";
PRODUCT_NAME = "$(TARGET_NAME)";
SDKROOT = macosx;
SUPPORTED_PLATFORMS = "macosx iphoneos iphonesimulator appletvos appletvsimulator watchos watchsimulator";
SWIFT_ACTIVE_COMPILATION_CONDITIONS = SWIFT_PACKAGE;
SWIFT_OPTIMIZATION_LEVEL = "-Owholemodule";
SWIFT_VERSION = 3.0;
TVOS_DEPLOYMENT_TARGET = 9.0;
USE_HEADERMAP = NO;
WATCHOS_DEPLOYMENT_TARGET = 2.0;
};
name = Release;
};
Expand Down
5 changes: 3 additions & 2 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,10 @@
![Linux](https://img.shields.io/badge/os-linux-green.svg?style=flat)
![Apache 2](https://img.shields.io/badge/license-Apache2-blue.svg?style=flat)
[![codecov](https://codecov.io/gh/IBM-Swift/swift-html-entities/branch/master/graph/badge.svg)](https://codecov.io/gh/IBM-Swift/swift-html-entities)
[![Carthage compatible](https://img.shields.io/badge/Carthage-compatible-4BC51D.svg?style=flat)](https://github.com/Carthage/Carthage)

## Summary
Pure Swift HTML encode/decode utility tool for Swift 3.
Pure Swift HTML encode/decode utility tool for Swift.

Includes support for HTML5 named character references. You can find the list of all 2231 HTML5 named character references [here](https://www.w3.org/TR/html5/syntax.html#named-character-references).

Expand All @@ -29,7 +30,7 @@ API documentation for `HTMLEntities` is located [here](https://ibm-swift.github.

## Version Info

`HTMLEntities` 3.0 requires Swift 3, on both macOS and Ubuntu Linux.
Latest release of `HTMLEntities` requires Swift 3.

## Installation

Expand Down
6 changes: 3 additions & 3 deletions docs/Enums.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -87,9 +87,9 @@ <h1>Enums</h1>
<li class="item">
<div>
<code>
<a name="/s:12HTMLEntities10ParseErrorO"></a>
<a name="/s:O12HTMLEntities10ParseError"></a>
<a name="//apple_ref/swift/Enum/ParseError" class="dashAnchor"></a>
<a class="token" href="#/s:12HTMLEntities10ParseErrorO">ParseError</a>
<a class="token" href="#/s:O12HTMLEntities10ParseError">ParseError</a>
</code>
</div>
<div class="height-container">
Expand Down Expand Up @@ -123,7 +123,7 @@ <h4>Declaration</h4>
</article>
</div>
<section class="footer">
<p>&copy; 2017 <a class="link" href="https://github.com/IBM-Swift/swift-html-entities" target="_blank" rel="external">IBM</a>. All rights reserved. (Last updated: 2017-07-31)</p>
<p>&copy; 2017 <a class="link" href="https://github.com/IBM-Swift/swift-html-entities" target="_blank" rel="external">IBM</a>. All rights reserved. (Last updated: 2017-09-07)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.8.1</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</body>
Expand Down
30 changes: 15 additions & 15 deletions docs/Enums/ParseError.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -97,9 +97,9 @@ <h1>ParseError</h1>
<li class="item">
<div>
<code>
<a name="/s:12HTMLEntities10ParseErrorO26DeprecatedNumericReferenceACSScACmF"></a>
<a name="/s:FO12HTMLEntities10ParseError26DeprecatedNumericReferenceFMS0_FSSS0_"></a>
<a name="//apple_ref/swift/Element/DeprecatedNumericReference" class="dashAnchor"></a>
<a class="token" href="#/s:12HTMLEntities10ParseErrorO26DeprecatedNumericReferenceACSScACmF">DeprecatedNumericReference</a>
<a class="token" href="#/s:FO12HTMLEntities10ParseError26DeprecatedNumericReferenceFMS0_FSSS0_">DeprecatedNumericReference</a>
</code>
</div>
<div class="height-container">
Expand Down Expand Up @@ -129,9 +129,9 @@ <h4>Declaration</h4>
<li class="item">
<div>
<code>
<a name="/s:12HTMLEntities10ParseErrorO26DisallowedNumericReferenceACSScACmF"></a>
<a name="/s:FO12HTMLEntities10ParseError26DisallowedNumericReferenceFMS0_FSSS0_"></a>
<a name="//apple_ref/swift/Element/DisallowedNumericReference" class="dashAnchor"></a>
<a class="token" href="#/s:12HTMLEntities10ParseErrorO26DisallowedNumericReferenceACSScACmF">DisallowedNumericReference</a>
<a class="token" href="#/s:FO12HTMLEntities10ParseError26DisallowedNumericReferenceFMS0_FSSS0_">DisallowedNumericReference</a>
</code>
</div>
<div class="height-container">
Expand Down Expand Up @@ -166,9 +166,9 @@ <h4>Declaration</h4>
<li class="item">
<div>
<code>
<a name="/s:12HTMLEntities10ParseErrorO15IllegalArgumentACSScACmF"></a>
<a name="/s:FO12HTMLEntities10ParseError15IllegalArgumentFMS0_FSSS0_"></a>
<a name="//apple_ref/swift/Element/IllegalArgument" class="dashAnchor"></a>
<a class="token" href="#/s:12HTMLEntities10ParseErrorO15IllegalArgumentACSScACmF">IllegalArgument</a>
<a class="token" href="#/s:FO12HTMLEntities10ParseError15IllegalArgumentFMS0_FSSS0_">IllegalArgument</a>
</code>
</div>
<div class="height-container">
Expand Down Expand Up @@ -198,9 +198,9 @@ <h4>Declaration</h4>
<li class="item">
<div>
<code>
<a name="/s:12HTMLEntities10ParseErrorO21InvalidNamedReferenceACSScACmF"></a>
<a name="/s:FO12HTMLEntities10ParseError21InvalidNamedReferenceFMS0_FSSS0_"></a>
<a name="//apple_ref/swift/Element/InvalidNamedReference" class="dashAnchor"></a>
<a class="token" href="#/s:12HTMLEntities10ParseErrorO21InvalidNamedReferenceACSScACmF">InvalidNamedReference</a>
<a class="token" href="#/s:FO12HTMLEntities10ParseError21InvalidNamedReferenceFMS0_FSSS0_">InvalidNamedReference</a>
</code>
</div>
<div class="height-container">
Expand Down Expand Up @@ -231,9 +231,9 @@ <h4>Declaration</h4>
<li class="item">
<div>
<code>
<a name="/s:12HTMLEntities10ParseErrorO25MalformedNumericReferenceACSScACmF"></a>
<a name="/s:FO12HTMLEntities10ParseError25MalformedNumericReferenceFMS0_FSSS0_"></a>
<a name="//apple_ref/swift/Element/MalformedNumericReference" class="dashAnchor"></a>
<a class="token" href="#/s:12HTMLEntities10ParseErrorO25MalformedNumericReferenceACSScACmF">MalformedNumericReference</a>
<a class="token" href="#/s:FO12HTMLEntities10ParseError25MalformedNumericReferenceFMS0_FSSS0_">MalformedNumericReference</a>
</code>
</div>
<div class="height-container">
Expand Down Expand Up @@ -264,9 +264,9 @@ <h4>Declaration</h4>
<li class="item">
<div>
<code>
<a name="/s:12HTMLEntities10ParseErrorO16MissingSemicolonACSScACmF"></a>
<a name="/s:FO12HTMLEntities10ParseError16MissingSemicolonFMS0_FSSS0_"></a>
<a name="//apple_ref/swift/Element/MissingSemicolon" class="dashAnchor"></a>
<a class="token" href="#/s:12HTMLEntities10ParseErrorO16MissingSemicolonACSScACmF">MissingSemicolon</a>
<a class="token" href="#/s:FO12HTMLEntities10ParseError16MissingSemicolonFMS0_FSSS0_">MissingSemicolon</a>
</code>
</div>
<div class="height-container">
Expand Down Expand Up @@ -296,9 +296,9 @@ <h4>Declaration</h4>
<li class="item">
<div>
<code>
<a name="/s:12HTMLEntities10ParseErrorO24OutsideValidUnicodeRangeACSScACmF"></a>
<a name="/s:FO12HTMLEntities10ParseError24OutsideValidUnicodeRangeFMS0_FSSS0_"></a>
<a name="//apple_ref/swift/Element/OutsideValidUnicodeRange" class="dashAnchor"></a>
<a class="token" href="#/s:12HTMLEntities10ParseErrorO24OutsideValidUnicodeRangeACSScACmF">OutsideValidUnicodeRange</a>
<a class="token" href="#/s:FO12HTMLEntities10ParseError24OutsideValidUnicodeRangeFMS0_FSSS0_">OutsideValidUnicodeRange</a>
</code>
</div>
<div class="height-container">
Expand Down Expand Up @@ -329,7 +329,7 @@ <h4>Declaration</h4>
</article>
</div>
<section class="footer">
<p>&copy; 2017 <a class="link" href="https://github.com/IBM-Swift/swift-html-entities" target="_blank" rel="external">IBM</a>. All rights reserved. (Last updated: 2017-07-31)</p>
<p>&copy; 2017 <a class="link" href="https://github.com/IBM-Swift/swift-html-entities" target="_blank" rel="external">IBM</a>. All rights reserved. (Last updated: 2017-09-07)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.8.1</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</body>
Expand Down
2 changes: 1 addition & 1 deletion docs/Extensions.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -119,7 +119,7 @@ <h4>Declaration</h4>
</article>
</div>
<section class="footer">
<p>&copy; 2017 <a class="link" href="https://github.com/IBM-Swift/swift-html-entities" target="_blank" rel="external">IBM</a>. All rights reserved. (Last updated: 2017-07-31)</p>
<p>&copy; 2017 <a class="link" href="https://github.com/IBM-Swift/swift-html-entities" target="_blank" rel="external">IBM</a>. All rights reserved. (Last updated: 2017-09-07)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.8.1</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</body>
Expand Down
96 changes: 87 additions & 9 deletions docs/Extensions/String.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -93,9 +93,9 @@ <h1>String</h1>
<li class="item">
<div>
<code>
<a name="/s:SS12HTMLEntitiesE17HTMLEscapeOptionsV"></a>
<a name="/s:VE12HTMLEntitiesSS17HTMLEscapeOptions"></a>
<a name="//apple_ref/swift/Struct/HTMLEscapeOptions" class="dashAnchor"></a>
<a class="token" href="#/s:SS12HTMLEntitiesE17HTMLEscapeOptionsV">HTMLEscapeOptions</a>
<a class="token" href="#/s:VE12HTMLEntitiesSS17HTMLEscapeOptions">HTMLEscapeOptions</a>
</code>
</div>
<div class="height-container">
Expand All @@ -121,9 +121,9 @@ <h4>Declaration</h4>
<li class="item">
<div>
<code>
<a name="/s:SS12HTMLEntitiesE10htmlEscapeSSSb18allowUnsafeSymbols_Sb7decimalSb16encodeEverythingSb18useNamedReferencestF"></a>
<a name="/s:FE12HTMLEntitiesSS10htmlEscapeFT18allowUnsafeSymbolsSb7decimalSb16encodeEverythingSb18useNamedReferencesSb_SS"></a>
<a name="//apple_ref/swift/Method/htmlEscape(allowUnsafeSymbols:decimal:encodeEverything:useNamedReferences:)" class="dashAnchor"></a>
<a class="token" href="#/s:SS12HTMLEntitiesE10htmlEscapeSSSb18allowUnsafeSymbols_Sb7decimalSb16encodeEverythingSb18useNamedReferencestF">htmlEscape(allowUnsafeSymbols:decimal:encodeEverything:useNamedReferences:)</a>
<a class="token" href="#/s:FE12HTMLEntitiesSS10htmlEscapeFT18allowUnsafeSymbolsSb7decimalSb16encodeEverythingSb18useNamedReferencesSb_SS">htmlEscape(allowUnsafeSymbols:decimal:encodeEverything:useNamedReferences:)</a>
</code>
</div>
<div class="height-container">
Expand Down Expand Up @@ -156,15 +156,74 @@ <h4>Declaration</h4>

</div>
</div>
<div>
<h4>Parameters</h4>
<table class="graybox">
<tbody>
<tr>
<td>
<code>
<em>allowUnsafeSymbols</em>
</code>
</td>
<td>
<div>
<p>Specifies if all ASCII characters should be skipped
when escaping text. <em>Optional</em></p>
</div>
</td>
</tr>
<tr>
<td>
<code>
<em>decimal</em>
</code>
</td>
<td>
<div>
<p>Specifies if decimal escapes should be used instead of
hexadecimal escapes. <em>Optional</em></p>
</div>
</td>
</tr>
<tr>
<td>
<code>
<em>encodeEverything</em>
</code>
</td>
<td>
<div>
<p>Specifies if all characters should be escaped, even if
some are safe characters. <em>Optional</em></p>
</div>
</td>
</tr>
<tr>
<td>
<code>
<em>useNamedReferences</em>
</code>
</td>
<td>
<div>
<p>Specifies if named character references
should be used whenever possible. <em>Optional</em></p>
</div>
</td>
</tr>
</tbody>
</table>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:SS12HTMLEntitiesE12htmlUnescapeSSSb6strict_tKF"></a>
<a name="/s:FE12HTMLEntitiesSS12htmlUnescapeFzT6strictSb_SS"></a>
<a name="//apple_ref/swift/Method/htmlUnescape(strict:)" class="dashAnchor"></a>
<a class="token" href="#/s:SS12HTMLEntitiesE12htmlUnescapeSSSb6strict_tKF">htmlUnescape(strict:)</a>
<a class="token" href="#/s:FE12HTMLEntitiesSS12htmlUnescapeFzT6strictSb_SS">htmlUnescape(strict:)</a>
</code>
</div>
<div class="height-container">
Expand Down Expand Up @@ -195,15 +254,34 @@ <h4>Declaration</h4>

</div>
</div>
<div>
<h4>Parameters</h4>
<table class="graybox">
<tbody>
<tr>
<td>
<code>
<em>strict</em>
</code>
</td>
<td>
<div>
<p>Specifies if escapes MUST always end with <code>;</code>.</p>
</div>
</td>
</tr>
</tbody>
</table>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:SS12HTMLEntitiesE12htmlUnescapeSSyF"></a>
<a name="/s:FE12HTMLEntitiesSS12htmlUnescapeFT_SS"></a>
<a name="//apple_ref/swift/Method/htmlUnescape()" class="dashAnchor"></a>
<a class="token" href="#/s:SS12HTMLEntitiesE12htmlUnescapeSSyF">htmlUnescape()</a>
<a class="token" href="#/s:FE12HTMLEntitiesSS12htmlUnescapeFT_SS">htmlUnescape()</a>
</code>
</div>
<div class="height-container">
Expand Down Expand Up @@ -242,7 +320,7 @@ <h4>Declaration</h4>
</article>
</div>
<section class="footer">
<p>&copy; 2017 <a class="link" href="https://github.com/IBM-Swift/swift-html-entities" target="_blank" rel="external">IBM</a>. All rights reserved. (Last updated: 2017-07-31)</p>
<p>&copy; 2017 <a class="link" href="https://github.com/IBM-Swift/swift-html-entities" target="_blank" rel="external">IBM</a>. All rights reserved. (Last updated: 2017-09-07)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.8.1</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</body>
Expand Down
Loading

0 comments on commit e51f2ab

Please sign in to comment.