Skip to content

Commit e51f2ab

Browse files
youming-linyouming-lin
committed
Set lower deployment targets; update README
1 parent eab2e39 commit e51f2ab

File tree

18 files changed

+253
-88
lines changed

18 files changed

+253
-88
lines changed

‎HTMLEntities-Carthage.xcodeproj/project.pbxproj‎

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -262,7 +262,8 @@
262262
DYLIB_INSTALL_NAME_BASE = "@rpath";
263263
ENABLE_NS_ASSERTIONS = YES;
264264
GCC_OPTIMIZATION_LEVEL = 0;
265-
MACOSX_DEPLOYMENT_TARGET = 10.10;
265+
IPHONEOS_DEPLOYMENT_TARGET = 8.0;
266+
MACOSX_DEPLOYMENT_TARGET = 10.9;
266267
ONLY_ACTIVE_ARCH = YES;
267268
OTHER_SWIFT_FLAGS = "-DXcode";
268269
PRODUCT_NAME = "$(TARGET_NAME)";
@@ -271,7 +272,9 @@
271272
SWIFT_ACTIVE_COMPILATION_CONDITIONS = SWIFT_PACKAGE;
272273
SWIFT_OPTIMIZATION_LEVEL = "-Onone";
273274
SWIFT_VERSION = 3.0;
275+
TVOS_DEPLOYMENT_TARGET = 9.0;
274276
USE_HEADERMAP = NO;
277+
WATCHOS_DEPLOYMENT_TARGET = 2.0;
275278
};
276279
name = Debug;
277280
};
@@ -318,15 +321,18 @@
318321
DEBUG_INFORMATION_FORMAT = "dwarf-with-dsym";
319322
DYLIB_INSTALL_NAME_BASE = "@rpath";
320323
GCC_OPTIMIZATION_LEVEL = s;
321-
MACOSX_DEPLOYMENT_TARGET = 10.10;
324+
IPHONEOS_DEPLOYMENT_TARGET = 8.0;
325+
MACOSX_DEPLOYMENT_TARGET = 10.9;
322326
OTHER_SWIFT_FLAGS = "-DXcode";
323327
PRODUCT_NAME = "$(TARGET_NAME)";
324328
SDKROOT = macosx;
325329
SUPPORTED_PLATFORMS = "macosx iphoneos iphonesimulator appletvos appletvsimulator watchos watchsimulator";
326330
SWIFT_ACTIVE_COMPILATION_CONDITIONS = SWIFT_PACKAGE;
327331
SWIFT_OPTIMIZATION_LEVEL = "-Owholemodule";
328332
SWIFT_VERSION = 3.0;
333+
TVOS_DEPLOYMENT_TARGET = 9.0;
329334
USE_HEADERMAP = NO;
335+
WATCHOS_DEPLOYMENT_TARGET = 2.0;
330336
};
331337
name = Release;
332338
};

‎README.md‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,10 @@
55
![Linux](https://img.shields.io/badge/os-linux-green.svg?style=flat)
66
![Apache 2](https://img.shields.io/badge/license-Apache2-blue.svg?style=flat)
77
[![codecov](https://codecov.io/gh/IBM-Swift/swift-html-entities/branch/master/graph/badge.svg)](https://codecov.io/gh/IBM-Swift/swift-html-entities)
8+
[![Carthage compatible](https://img.shields.io/badge/Carthage-compatible-4BC51D.svg?style=flat)](https://github.com/Carthage/Carthage)
89

910
## Summary
10-
Pure Swift HTML encode/decode utility tool for Swift 3.
11+
Pure Swift HTML encode/decode utility tool for Swift.
1112

1213
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).
1314

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

3031
## Version Info
3132

32-
`HTMLEntities` 3.0 requires Swift 3, on both macOS and Ubuntu Linux.
33+
Latest release of `HTMLEntities` requires Swift 3.
3334

3435
## Installation
3536

‎docs/Enums.html‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -87,9 +87,9 @@ <h1>Enums</h1>
8787
<li class="item">
8888
<div>
8989
<code>
90-
<a name="/s:12HTMLEntities10ParseErrorO"></a>
90+
<a name="/s:O12HTMLEntities10ParseError"></a>
9191
<a name="//apple_ref/swift/Enum/ParseError" class="dashAnchor"></a>
92-
<a class="token" href="#/s:12HTMLEntities10ParseErrorO">ParseError</a>
92+
<a class="token" href="#/s:O12HTMLEntities10ParseError">ParseError</a>
9393
</code>
9494
</div>
9595
<div class="height-container">
@@ -123,7 +123,7 @@ <h4>Declaration</h4>
123123
</article>
124124
</div>
125125
<section class="footer">
126-
<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>
126+
<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>
127127
<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>
128128
</section>
129129
</body>

‎docs/Enums/ParseError.html‎

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -97,9 +97,9 @@ <h1>ParseError</h1>
9797
<li class="item">
9898
<div>
9999
<code>
100-
<a name="/s:12HTMLEntities10ParseErrorO26DeprecatedNumericReferenceACSScACmF"></a>
100+
<a name="/s:FO12HTMLEntities10ParseError26DeprecatedNumericReferenceFMS0_FSSS0_"></a>
101101
<a name="//apple_ref/swift/Element/DeprecatedNumericReference" class="dashAnchor"></a>
102-
<a class="token" href="#/s:12HTMLEntities10ParseErrorO26DeprecatedNumericReferenceACSScACmF">DeprecatedNumericReference</a>
102+
<a class="token" href="#/s:FO12HTMLEntities10ParseError26DeprecatedNumericReferenceFMS0_FSSS0_">DeprecatedNumericReference</a>
103103
</code>
104104
</div>
105105
<div class="height-container">
@@ -129,9 +129,9 @@ <h4>Declaration</h4>
129129
<li class="item">
130130
<div>
131131
<code>
132-
<a name="/s:12HTMLEntities10ParseErrorO26DisallowedNumericReferenceACSScACmF"></a>
132+
<a name="/s:FO12HTMLEntities10ParseError26DisallowedNumericReferenceFMS0_FSSS0_"></a>
133133
<a name="//apple_ref/swift/Element/DisallowedNumericReference" class="dashAnchor"></a>
134-
<a class="token" href="#/s:12HTMLEntities10ParseErrorO26DisallowedNumericReferenceACSScACmF">DisallowedNumericReference</a>
134+
<a class="token" href="#/s:FO12HTMLEntities10ParseError26DisallowedNumericReferenceFMS0_FSSS0_">DisallowedNumericReference</a>
135135
</code>
136136
</div>
137137
<div class="height-container">
@@ -166,9 +166,9 @@ <h4>Declaration</h4>
166166
<li class="item">
167167
<div>
168168
<code>
169-
<a name="/s:12HTMLEntities10ParseErrorO15IllegalArgumentACSScACmF"></a>
169+
<a name="/s:FO12HTMLEntities10ParseError15IllegalArgumentFMS0_FSSS0_"></a>
170170
<a name="//apple_ref/swift/Element/IllegalArgument" class="dashAnchor"></a>
171-
<a class="token" href="#/s:12HTMLEntities10ParseErrorO15IllegalArgumentACSScACmF">IllegalArgument</a>
171+
<a class="token" href="#/s:FO12HTMLEntities10ParseError15IllegalArgumentFMS0_FSSS0_">IllegalArgument</a>
172172
</code>
173173
</div>
174174
<div class="height-container">
@@ -198,9 +198,9 @@ <h4>Declaration</h4>
198198
<li class="item">
199199
<div>
200200
<code>
201-
<a name="/s:12HTMLEntities10ParseErrorO21InvalidNamedReferenceACSScACmF"></a>
201+
<a name="/s:FO12HTMLEntities10ParseError21InvalidNamedReferenceFMS0_FSSS0_"></a>
202202
<a name="//apple_ref/swift/Element/InvalidNamedReference" class="dashAnchor"></a>
203-
<a class="token" href="#/s:12HTMLEntities10ParseErrorO21InvalidNamedReferenceACSScACmF">InvalidNamedReference</a>
203+
<a class="token" href="#/s:FO12HTMLEntities10ParseError21InvalidNamedReferenceFMS0_FSSS0_">InvalidNamedReference</a>
204204
</code>
205205
</div>
206206
<div class="height-container">
@@ -231,9 +231,9 @@ <h4>Declaration</h4>
231231
<li class="item">
232232
<div>
233233
<code>
234-
<a name="/s:12HTMLEntities10ParseErrorO25MalformedNumericReferenceACSScACmF"></a>
234+
<a name="/s:FO12HTMLEntities10ParseError25MalformedNumericReferenceFMS0_FSSS0_"></a>
235235
<a name="//apple_ref/swift/Element/MalformedNumericReference" class="dashAnchor"></a>
236-
<a class="token" href="#/s:12HTMLEntities10ParseErrorO25MalformedNumericReferenceACSScACmF">MalformedNumericReference</a>
236+
<a class="token" href="#/s:FO12HTMLEntities10ParseError25MalformedNumericReferenceFMS0_FSSS0_">MalformedNumericReference</a>
237237
</code>
238238
</div>
239239
<div class="height-container">
@@ -264,9 +264,9 @@ <h4>Declaration</h4>
264264
<li class="item">
265265
<div>
266266
<code>
267-
<a name="/s:12HTMLEntities10ParseErrorO16MissingSemicolonACSScACmF"></a>
267+
<a name="/s:FO12HTMLEntities10ParseError16MissingSemicolonFMS0_FSSS0_"></a>
268268
<a name="//apple_ref/swift/Element/MissingSemicolon" class="dashAnchor"></a>
269-
<a class="token" href="#/s:12HTMLEntities10ParseErrorO16MissingSemicolonACSScACmF">MissingSemicolon</a>
269+
<a class="token" href="#/s:FO12HTMLEntities10ParseError16MissingSemicolonFMS0_FSSS0_">MissingSemicolon</a>
270270
</code>
271271
</div>
272272
<div class="height-container">
@@ -296,9 +296,9 @@ <h4>Declaration</h4>
296296
<li class="item">
297297
<div>
298298
<code>
299-
<a name="/s:12HTMLEntities10ParseErrorO24OutsideValidUnicodeRangeACSScACmF"></a>
299+
<a name="/s:FO12HTMLEntities10ParseError24OutsideValidUnicodeRangeFMS0_FSSS0_"></a>
300300
<a name="//apple_ref/swift/Element/OutsideValidUnicodeRange" class="dashAnchor"></a>
301-
<a class="token" href="#/s:12HTMLEntities10ParseErrorO24OutsideValidUnicodeRangeACSScACmF">OutsideValidUnicodeRange</a>
301+
<a class="token" href="#/s:FO12HTMLEntities10ParseError24OutsideValidUnicodeRangeFMS0_FSSS0_">OutsideValidUnicodeRange</a>
302302
</code>
303303
</div>
304304
<div class="height-container">
@@ -329,7 +329,7 @@ <h4>Declaration</h4>
329329
</article>
330330
</div>
331331
<section class="footer">
332-
<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>
332+
<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>
333333
<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>
334334
</section>
335335
</body>

‎docs/Extensions.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -119,7 +119,7 @@ <h4>Declaration</h4>
119119
</article>
120120
</div>
121121
<section class="footer">
122-
<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>
122+
<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>
123123
<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>
124124
</section>
125125
</body>

‎docs/Extensions/String.html‎

Lines changed: 87 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -93,9 +93,9 @@ <h1>String</h1>
9393
<li class="item">
9494
<div>
9595
<code>
96-
<a name="/s:SS12HTMLEntitiesE17HTMLEscapeOptionsV"></a>
96+
<a name="/s:VE12HTMLEntitiesSS17HTMLEscapeOptions"></a>
9797
<a name="//apple_ref/swift/Struct/HTMLEscapeOptions" class="dashAnchor"></a>
98-
<a class="token" href="#/s:SS12HTMLEntitiesE17HTMLEscapeOptionsV">HTMLEscapeOptions</a>
98+
<a class="token" href="#/s:VE12HTMLEntitiesSS17HTMLEscapeOptions">HTMLEscapeOptions</a>
9999
</code>
100100
</div>
101101
<div class="height-container">
@@ -121,9 +121,9 @@ <h4>Declaration</h4>
121121
<li class="item">
122122
<div>
123123
<code>
124-
<a name="/s:SS12HTMLEntitiesE10htmlEscapeSSSb18allowUnsafeSymbols_Sb7decimalSb16encodeEverythingSb18useNamedReferencestF"></a>
124+
<a name="/s:FE12HTMLEntitiesSS10htmlEscapeFT18allowUnsafeSymbolsSb7decimalSb16encodeEverythingSb18useNamedReferencesSb_SS"></a>
125125
<a name="//apple_ref/swift/Method/htmlEscape(allowUnsafeSymbols:decimal:encodeEverything:useNamedReferences:)" class="dashAnchor"></a>
126-
<a class="token" href="#/s:SS12HTMLEntitiesE10htmlEscapeSSSb18allowUnsafeSymbols_Sb7decimalSb16encodeEverythingSb18useNamedReferencestF">htmlEscape(allowUnsafeSymbols:decimal:encodeEverything:useNamedReferences:)</a>
126+
<a class="token" href="#/s:FE12HTMLEntitiesSS10htmlEscapeFT18allowUnsafeSymbolsSb7decimalSb16encodeEverythingSb18useNamedReferencesSb_SS">htmlEscape(allowUnsafeSymbols:decimal:encodeEverything:useNamedReferences:)</a>
127127
</code>
128128
</div>
129129
<div class="height-container">
@@ -156,15 +156,74 @@ <h4>Declaration</h4>
156156

157157
</div>
158158
</div>
159+
<div>
160+
<h4>Parameters</h4>
161+
<table class="graybox">
162+
<tbody>
163+
<tr>
164+
<td>
165+
<code>
166+
<em>allowUnsafeSymbols</em>
167+
</code>
168+
</td>
169+
<td>
170+
<div>
171+
<p>Specifies if all ASCII characters should be skipped
172+
when escaping text. <em>Optional</em></p>
173+
</div>
174+
</td>
175+
</tr>
176+
<tr>
177+
<td>
178+
<code>
179+
<em>decimal</em>
180+
</code>
181+
</td>
182+
<td>
183+
<div>
184+
<p>Specifies if decimal escapes should be used instead of
185+
hexadecimal escapes. <em>Optional</em></p>
186+
</div>
187+
</td>
188+
</tr>
189+
<tr>
190+
<td>
191+
<code>
192+
<em>encodeEverything</em>
193+
</code>
194+
</td>
195+
<td>
196+
<div>
197+
<p>Specifies if all characters should be escaped, even if
198+
some are safe characters. <em>Optional</em></p>
199+
</div>
200+
</td>
201+
</tr>
202+
<tr>
203+
<td>
204+
<code>
205+
<em>useNamedReferences</em>
206+
</code>
207+
</td>
208+
<td>
209+
<div>
210+
<p>Specifies if named character references
211+
should be used whenever possible. <em>Optional</em></p>
212+
</div>
213+
</td>
214+
</tr>
215+
</tbody>
216+
</table>
217+
</div>
159218
</section>
160219
</div>
161220
</li>
162221
<li class="item">
163222
<div>
164223
<code>
165-
<a name="/s:SS12HTMLEntitiesE12htmlUnescapeSSSb6strict_tKF"></a>
224+
<a name="/s:FE12HTMLEntitiesSS12htmlUnescapeFzT6strictSb_SS"></a>
166225
<a name="//apple_ref/swift/Method/htmlUnescape(strict:)" class="dashAnchor"></a>
167-
<a class="token" href="#/s:SS12HTMLEntitiesE12htmlUnescapeSSSb6strict_tKF">htmlUnescape(strict:)</a>
226+
<a class="token" href="#/s:FE12HTMLEntitiesSS12htmlUnescapeFzT6strictSb_SS">htmlUnescape(strict:)</a>
168227
</code>
169228
</div>
170229
<div class="height-container">
@@ -195,15 +254,34 @@ <h4>Declaration</h4>
195254

196255
</div>
197256
</div>
257+
<div>
258+
<h4>Parameters</h4>
259+
<table class="graybox">
260+
<tbody>
261+
<tr>
262+
<td>
263+
<code>
264+
<em>strict</em>
265+
</code>
266+
</td>
267+
<td>
268+
<div>
269+
<p>Specifies if escapes MUST always end with <code>;</code>.</p>
270+
</div>
271+
</td>
272+
</tr>
273+
</tbody>
274+
</table>
275+
</div>
198276
</section>
199277
</div>
200278
</li>
201279
<li class="item">
202280
<div>
203281
<code>
204-
<a name="/s:SS12HTMLEntitiesE12htmlUnescapeSSyF"></a>
282+
<a name="/s:FE12HTMLEntitiesSS12htmlUnescapeFT_SS"></a>
205283
<a name="//apple_ref/swift/Method/htmlUnescape()" class="dashAnchor"></a>
206-
<a class="token" href="#/s:SS12HTMLEntitiesE12htmlUnescapeSSyF">htmlUnescape()</a>
284+
<a class="token" href="#/s:FE12HTMLEntitiesSS12htmlUnescapeFT_SS">htmlUnescape()</a>
207285
</code>
208286
</div>
209287
<div class="height-container">
@@ -242,7 +320,7 @@ <h4>Declaration</h4>
242320
</article>
243321
</div>
244322
<section class="footer">
245-
<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>
323+
<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>
246324
<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>
247325
</section>
248326
</body>

0 commit comments

Comments
 (0)