Releases: thatfactory/device
Releases · thatfactory/device
0.2.2
What's Changed
- Moved API usage documentation from
README.mdinto symbol-level DocC comments inSources/Device. - Added Swift usage examples to
orientation,screenSize,os(),type(),currentType(), andplatformDisplayNamedocs. - Added explicit
@availableannotations for UIKit-dependent APIs so platform availability is encoded in the API itself. - Added a DocC catalog page at
Sources/Device/Device.docc/Device.md. - Added
build_docsanddeploy_docsjobs to.github/workflows/release.yml. - Added a
DocCbadge toREADME.mdand reduced README API docs in favor of generated documentation. - Added
swift-docc-plugintoPackage.swiftto supportgenerate-documentationin release CI. - Updated
.gitignoreto include repository-level ignored artifacts such as.swiftpm/configuration/registries.jsonand/public-check/.
Notes
- This release is the intended DocC-enabled package release for the latest
masterchanges.
0.2.1
What's Changed
- Moved API usage documentation from
README.mdinto symbol-level DocC comments inSources/Device. - Added Swift usage examples to
orientation,screenSize,os(),type(),currentType(), andplatformDisplayNamedocs. - Added explicit
@availableannotations for UIKit-dependent APIs so platform availability is encoded in the API itself. - Added a DocC catalog page at
Sources/Device/Device.docc/Device.md. - Added
build_docsanddeploy_docsjobs to.github/workflows/release.yml. - Added a
DocCbadge toREADME.mdand reduced README API docs in favor of generated documentation. - Added
swift-docc-plugintoPackage.swiftto supportgenerate-documentationin release CI. - Updated
.gitignoreto include repository-level ignored artifacts such as.swiftpm/configuration/registries.jsonand/public-check/.
Notes
- This release keeps runtime behavior unchanged while moving docs to DocC-first API documentation and enabling automated docs deployment.
Device 0.2.0
Device 0.2.0
Added
- Added
Device.currentType()to retrieve the currentDeviceTypewithout manually creating an instance. - Added
DeviceType.platformDisplayNamefor stable user-facing platform labels (iOS,macOS,tvOS,watchOS,visionOS,Unknown).
Tests
- Added coverage for
Device.currentType()known-case behavior. - Added mapping coverage for
DeviceType.platformDisplayName.
Docs
- Updated
README.mdwith usage examples and API table entries for the new platform APIs.
0.1.1
Fix unknown typo in docs/tests.
0.1.0
Update references