Skip to content

Add DocC documentation catalogs to Essentials, Internationalization, and Preview modules. #283

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 7 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
# Foundation Essentials

Access core types and essential functionality used by most applications.

## Overview

The Foundation Essentials package provides the most important types for everyday development:

* Core types beyond those provided by the Swift standard library, such as ``Data`` and ``UUID``.
* Dates and time intervals.
* An ``AttributedString`` type for strings with runs of metadata, such as styling information.
* JSON encoding and decoding.
* A ``URL`` type for network and local resources.

Foundation Essentials provides a canonical implementation of these types, so developers can count on consistent behavior, regardless of platform.

## Topics

### Fundamentals

- <doc:NumbersDataAndBasicValues>
- <doc:StringsAndText>
- <doc:DatesAndTimes>
- <doc:FiltersAndSorting>

### App support

- <doc:Resources>
- <doc:ErrorsAndExceptions>

### Files and data persistence

- <doc:ArchivesAndSerialization>

### Networking

- <doc:URLs>
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# Errors and exceptions

## Topics

### User-relevant errors

- ``LocalizedError``
- ``CustomNSError``
- ``CocoaError``
- ``POSIXError``
- ``POSIXErrorCode``
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# Resources

## Topics

### Bundle resources

- ``Bundle``

Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# Archives and serialization

## Overview

Use these APIs to convert your app’s in-memory types to representations suitable for serialization over I/O and network interfaces or to long-term storage.

## Topics

### Serializing arbitrary payloads

- ``CodableWithConfiguration``
- ``CodableConfiguration``
- ``DecodableWithConfiguration``
- ``DecodingConfigurationProviding``
- ``EncodableWithConfiguration``
- ``EncodingConfigurationProviding``

### JSON

- ``JSONDecoder``
- ``JSONEncoder``
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# Dates and times

## Topics

### Date representations

- ``Date``
- ``DateInterval``
- ``TimeInterval``

Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# Filters and sorting

## Topics

### Filtering

- ``Predicate(_:)``
- ``Predicate``
- ``PredicateError``
- ``PredicateExpression``
- ``StandardPredicateExpression``
- ``PredicateExpressions``

### Sorting

- ``ComparisonResult-2po50``
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# ``FoundationPreview/Predicate``

## Topics

### Creating a predicate

- ``init(_:)``

### Evaluating a predicate

- ``evaluate(_:)``
- ``PredicateBindings``
- ``true``
- ``false``

### Inspecting predicate properties

- ``expression``
- ``PredicateExpression``
- ``variable``
- ``PredicateExpressions/Variable``
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
# ``FoundationPreview/Decimal``

## Topics

### Creating a decimal from components

### Creating a decimal from a floating-point number

- ``init(_:)-31n60``
- ``init(floatLiteral:)``

### Creating a decimal from an integer

- ``init(_:)-1u803``
- ``init(exactly:)``
- ``init(integerLiteral:)``

### Creating a decimal from an unsigned integer

### Creating a decimal from another decimal

### Creating a decimal from a string

- ``init(string:)``

### Converting between decimals and strings

### Converting to a floating-point value

- ``doubleValue``

### Performing arithmetic

### Getting a decimal's characteristics

### Getting particular decimals

### Encoding and decoding

- ``init(from:)``

### Describing a decimal

- ``description``

Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
# ``FoundationPreview/UUID``

## Topics

### Creating UUIDs

- ``init()``
- ``init(uuid:)``
- ``uuid_t``
- ``init(uuidString:)``
- ``uuid_string_t``

### Getting UUID values

- ``uuid``
- ``uuidString``

### Encoding and decoding

- ``init(from:)``
- ``encode(to:)``

### Describing UUIDs

- ``description``
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# Numbers, data, and basic values

## Topics

### Numbers

- ``Decimal``

### Binary Data

- ``Data``
- ``DataProtocol``
- ``MutableDataProtocol``
- ``ContiguousBytes``

### URLs

- ``URL``

### Unique identifiers

- ``UUID``
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# Strings and text

## Topics

### Strings with metadata

- ``AttributedString``
- ``AttributedSubstring``
- <doc:AttributedStringSupportingTypes>
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
# ``FoundationPreview/AttributeContainer``

## Topics

### Creating an attribute container

- ``init()``

### Accessing attributes

- ``subscript(_:)``
- ``subscript(dynamicMember:)-11gv5``
- ``subscript(dynamicMember:)-5u9at``
- ``subscript(dynamicMember:)-6cn2p``
- ``subscript(dynamicMember:)-swift.type.subscript``
- ``AttributedStringKey``
- ``Builder``

### Modifying attributes

- ``merge(_:mergePolicy:)``
- ``merging(_:mergePolicy:)``

### Encoding and decoding

- ``AttributeScopeCodableConfiguration``

### Interoperating with Objective-C attributes

### Comparing attribute containers

- ``!=(_:_:)``


### Describing an attribute container

- ``description``
Original file line number Diff line number Diff line change
@@ -0,0 +1,117 @@
# ``FoundationPreview/AttributedString``

## Topics

### Creating an attributed string

- ``init()``
- ``init(_:)``
- ``init(_:attributes:)-63o2i``
- ``init(_:attributes:)-8xciu``
- ``init(_:attributes:)-2bzas``
- ``AttributeContainer``

### Creating an attributed string from a literal value

- ``init(stringLiteral:)``

### Creating a localized attributed string

### Creating a localized attributed string with a default value

### Creating an attributed string from Markdown

- ``MarkdownDecodableAttributedStringKey``

### Creating an attributed string from a reference type

### Creating a duplicate attributed string

### Applying and modifying attributes

- ``setAttributes(_:)``
- ``mergeAttributes(_:mergePolicy:)``
- ``AttributeMergePolicy``
- ``replaceAttributes(_:with:)``
- ``AttributedStringAttributeMutation``

### Using defined attributes

- ``AttributeScopes``
- ``AttributeDynamicLookup``
- ``ScopedAttributeContainer``

### Searching for a substring

### Accessing a range

### Accessing indices

### Accessing views into the attributed string

- ``characters``
- ``CharacterView``
- ``unicodeScalars``
- ``UnicodeScalarView``
- ``runs``
- ``Runs-swift.struct``

### Modifying an attributed string

- ``insert(_:at:)``
- ``Index``
- ``removeSubrange(_:)``
- ``replaceSubrange(_:with:)``

### Transforming attributes

- ``transformingAttributes(_:_:)-59m1k``
- ``transformingAttributes(_:_:)-8cr3t``
- ``transformingAttributes(_:_:_:)-11oiz``
- ``transformingAttributes(_:_:_:)-829wo``
- ``transformingAttributes(_:_:_:_:)-5tbz3``
- ``transformingAttributes(_:_:_:_:_:)-256g2``
- ``transformingAttributes(_:_:_:_:)-1ixsp``
- ``transformingAttributes(_:_:_:_:_:_:)-1mmk``
- ``transformingAttributes(_:_:_:_:_:)-130gi``
- ``transformingAttributes(_:_:_:_:_:_:)-77ylt``
- ``SingleAttributeTransformer``

### Accessing whole-string attributes

- ``subscript(_:)-6no6u``
- ``subscript(_:)-87fzh``
- ``subscript(dynamicMember:)-3epmh``
- ``subscript(dynamicMember:)-1o7kw``
- ``AttributeDynamicLookup``
- ``ScopedAttributeContainer``

### Combining attributed strings

- ``append(_:)``
- ``+(_:_:)-1m4m5``
- ``+(_:_:)-8pfmv``
- ``+=(_:_:)-hi02``
- ``+=(_:_:)-mcpi``

### Performing automatic grammar agreement

### Performing string interpolation

### Comparing attributed strings

- ``==(_:_:)``

### Hashing

### Encoding and decoding

- <doc:EncodingAndDecodingAttributedStringKeys>


### Describing an attributed string

- ``description``



Loading