starting work on docc

brightdigit · Apr 24, 2024 · 5c237c9 · 5c237c9
1 parent bdd3d5f
commit 5c237c9
Show file tree

Hide file tree

Showing 18 changed files with 40 additions and 9 deletions.
diff --git a/.gitignore b/.gitignore
@@ -127,4 +127,7 @@ fastlane/test_output
 iOSInjectionProject/
 
 .mint
-Output
+Output
+
+# Due to support for 5.10 and below 
+Package.resolved
diff --git a/Documentation/Reference/Options/README.md → ...mentation-OLD/Reference/Options/README.md b/Documentation/Reference/Options/README.md → ...mentation-OLD/Reference/Options/README.md
@@ -25,5 +25,3 @@
 ## Typealiases
 
 -   [EnumSet.RawValue](typealiases/EnumSet.RawValue.md)
-
-This file was generated by [SourceDocs](https://github.com/eneko/SourceDocs)
diff --git a/...ns/enums/MappedValueRepresentableError.md → ...ns/enums/MappedValueRepresentableError.md b/...ns/enums/MappedValueRepresentableError.md → ...ns/enums/MappedValueRepresentableError.md
diff --git a/...n/Reference/Options/extensions/EnumSet.md → ...D/Reference/Options/extensions/EnumSet.md b/...n/Reference/Options/extensions/EnumSet.md → ...D/Reference/Options/extensions/EnumSet.md
diff --git a/...sions/MappedValueCollectionRepresented.md → ...sions/MappedValueCollectionRepresented.md b/...sions/MappedValueCollectionRepresented.md → ...sions/MappedValueCollectionRepresented.md
diff --git a/...sions/MappedValueDictionaryRepresented.md → ...sions/MappedValueDictionaryRepresented.md b/...sions/MappedValueDictionaryRepresented.md → ...sions/MappedValueDictionaryRepresented.md
diff --git a/...ns/extensions/MappedValueRepresentable.md → ...ns/extensions/MappedValueRepresentable.md b/...ns/extensions/MappedValueRepresentable.md → ...ns/extensions/MappedValueRepresentable.md
diff --git a/...ocols/MappedValueCollectionRepresented.md → ...ocols/MappedValueCollectionRepresented.md b/...ocols/MappedValueCollectionRepresented.md → ...ocols/MappedValueCollectionRepresented.md
diff --git a/...ocols/MappedValueDictionaryRepresented.md → ...ocols/MappedValueDictionaryRepresented.md b/...ocols/MappedValueDictionaryRepresented.md → ...ocols/MappedValueDictionaryRepresented.md
diff --git a/...ons/protocols/MappedValueRepresentable.md → ...ons/protocols/MappedValueRepresentable.md b/...ons/protocols/MappedValueRepresentable.md → ...ons/protocols/MappedValueRepresentable.md
diff --git a/...tion/Reference/Options/structs/EnumSet.md → ...-OLD/Reference/Options/structs/EnumSet.md b/...tion/Reference/Options/structs/EnumSet.md → ...-OLD/Reference/Options/structs/EnumSet.md
diff --git a/...n/Reference/Options/structs/MappedEnum.md → ...D/Reference/Options/structs/MappedEnum.md b/...n/Reference/Options/structs/MappedEnum.md → ...D/Reference/Options/structs/MappedEnum.md
diff --git a/...e/Options/typealiases/EnumSet.RawValue.md → ...e/Options/typealiases/EnumSet.RawValue.md b/...e/Options/typealiases/EnumSet.RawValue.md → ...e/Options/typealiases/EnumSet.RawValue.md
diff --git a/Sources/Options/Array.swift b/Sources/Options/Array.swift
@@ -29,7 +29,7 @@
 
 // swiftlint:disable:next line_length
 @available(*, deprecated, renamed: "MappedValueGenericRepresented", message: "Use MappedValueGenericRepresented instead.")
-public protocol MappedValueCollectionRepresented: MappedValueGenericRepresented
+public protocol MappedValueCollectionRepresented: MappedValueRepresented
   where MappedValueType: Sequence {}
 
 extension Array: MappedValues where Element: Equatable {

diff --git a/Sources/Options/Dictionary.swift b/Sources/Options/Dictionary.swift
@@ -29,7 +29,7 @@
 
 // swiftlint:disable:next line_length
 @available(*, deprecated, renamed: "MappedValueGenericRepresented", message: "Use MappedValueGenericRepresented instead.")
-public protocol MappedValueDictionaryRepresented: MappedValueGenericRepresented
+public protocol MappedValueDictionaryRepresented: MappedValueRepresented
   where MappedValueType == [Int: MappedType] {}
 
 extension Dictionary: MappedValues where Key == Int, Value: Equatable {

diff --git a/Sources/Options/Documentation.docc/Documentation.md b/Sources/Options/Documentation.docc/Documentation.md
@@ -0,0 +1,30 @@
+# ``Options``
+
+Summary
+
+## Overview
+
+Text
+
+## Topics
+
+### Options conformance
+
+- ``Options()``
+- ``MappedValueRepresentable``
+- ``MappedValueRepresented``
+- ``EnumSet``
+
+### Advanced customization
+
+- ``MappedEnum``
+- ``MappedValues``
+
+### Errors
+
+- ``MappedValueRepresentableError-2k4ki``
+
+### Deprecated 
+
+- ``MappedValueCollectionRepresented``
+- ``MappedValueDictionaryRepresented``
diff --git a/Sources/Options/Macro.swift b/Sources/Options/Macro.swift
@@ -32,7 +32,7 @@ import Foundation
 #if swift(>=5.10)
   @attached(
     extension,
-    conformances: MappedValueRepresentable, MappedValueGenericRepresented,
+    conformances: MappedValueRepresentable, MappedValueRepresented,
     names: named(MappedType), named(mappedValues)
   )
   @attached(peer, names: suffixed(Set))

diff --git a/...tions/MappedValueGenericRepresented.swift → Sources/Options/MappedValueRepresented.swift b/...tions/MappedValueGenericRepresented.swift → Sources/Options/MappedValueRepresented.swift
@@ -1,5 +1,5 @@
 //
-//  MappedValueGenericRepresented.swift
+//  MappedValueRepresented.swift
 //  SimulatorServices
 //
 //  Created by Leo Dion.
@@ -28,14 +28,14 @@
 //
 
 /// Protocol which simplifies ``MappedValueRepresentable``by using a ``MappedValues``.
-public protocol MappedValueGenericRepresented: MappedValueRepresentable
+public protocol MappedValueRepresented: MappedValueRepresentable
   where RawValue == Int, MappedType: Equatable {
   associatedtype MappedValueType: MappedValues<MappedType>
   /// An array of the mapped values which lines up with each case.
   static var mappedValues: MappedValueType { get }
 }
 
-extension MappedValueGenericRepresented {
+extension MappedValueRepresented {
   /// Gets the raw value based on the MappedType by finding the index of the mapped value.
   /// - Parameter value: MappedType value.
   /// - Throws: `MappedValueCollectionRepresentedError.valueNotFound`
Original file line number	Diff line number	Diff line change
Expand Up		@@ -25,5 +25,3 @@
		## Typealiases

		- [EnumSet.RawValue](typealiases/EnumSet.RawValue.md)

		This file was generated by [SourceDocs](https://github.com/eneko/SourceDocs)