From 9cc47bd545d719320245614239fc3dc783e7bb6a Mon Sep 17 00:00:00 2001 From: art-divin Date: Sun, 29 Dec 2024 08:09:51 +0000 Subject: [PATCH] Update Docs --- Gemfile.lock | 20 +++++++++----------- Package.resolved | 18 ++++++++++++++++++ docs/Classes/Actor.html | 2 +- docs/Classes/Class.html | 2 +- docs/Classes/ClosureParameter.html | 2 +- docs/Classes/ClosureType.html | 2 +- docs/Classes/Method.html | 6 +++--- docs/Classes/MethodParameter.html | 2 +- docs/Classes/Subscript.html | 4 ++-- docs/Classes/TypeName.html | 2 +- docs/Classes/Variable.html | 2 +- docs/Other Classes.html | 2 +- docs/Types.html | 4 ++-- docs/codable.html | 18 +++++++++--------- docs/usage.html | 21 +++++++++++++++------ 15 files changed, 66 insertions(+), 41 deletions(-) diff --git a/Gemfile.lock b/Gemfile.lock index d320c9158..c9acfc49b 100644 --- a/Gemfile.lock +++ b/Gemfile.lock @@ -5,18 +5,16 @@ GEM base64 nkf rexml - activesupport (7.2.2.1) + activesupport (7.1.4.2) base64 - benchmark (>= 0.3) bigdecimal - concurrent-ruby (~> 1.0, >= 1.3.1) + concurrent-ruby (~> 1.0, >= 1.0.2) connection_pool (>= 2.2.5) drb i18n (>= 1.6, < 2) - logger (>= 1.4.2) minitest (>= 5.1) - securerandom (>= 0.3) - tzinfo (~> 2.0, >= 2.0.5) + mutex_m + tzinfo (~> 2.0) addressable (2.8.7) public_suffix (>= 2.0.2, < 7.0) algoliasearch (1.27.5) @@ -24,7 +22,6 @@ GEM json (>= 1.5.1) atomos (0.1.3) base64 (0.2.0) - benchmark (0.4.0) bigdecimal (3.1.9) claide (1.1.0) claide-plugins (0.9.2) @@ -131,16 +128,17 @@ GEM minitest (5.25.4) molinillo (0.8.0) mustache (1.1.1) + mutex_m (0.3.0) nanaimo (0.4.0) nap (1.1.0) net-http (0.6.0) uri netrc (0.11.0) nkf (0.2.0) - nokogiri (1.18.0) + nokogiri (1.17.2) mini_portile2 (~> 2.8.2) racc (~> 1.4) - nokogiri (1.18.0-arm64-darwin) + nokogiri (1.17.2-arm64-darwin) racc (~> 1.4) octokit (9.2.0) faraday (>= 1, < 3) @@ -160,7 +158,6 @@ GEM sawyer (0.9.2) addressable (>= 2.3.5) faraday (>= 0.17.3, < 3) - securerandom (0.4.1) slather (2.8.5) CFPropertyList (>= 2.2, < 4) activesupport @@ -169,6 +166,7 @@ GEM xcodeproj (~> 1.27) sqlite3 (1.7.3) mini_portile2 (~> 2.8.0) + sqlite3 (1.7.3-arm64-darwin) terminal-table (3.0.2) unicode-display_width (>= 1.1.1, < 3) typhoeus (1.4.1) @@ -204,4 +202,4 @@ DEPENDENCIES xcpretty BUNDLED WITH - 2.6.2 + 2.5.23 diff --git a/Package.resolved b/Package.resolved index e51b3dc0f..a9c26e538 100644 --- a/Package.resolved +++ b/Package.resolved @@ -18,6 +18,24 @@ "version" : "0.9.1" } }, + { + "identity" : "cwlcatchexception", + "kind" : "remoteSourceControl", + "location" : "https://github.com/mattgallagher/CwlCatchException.git", + "state" : { + "revision" : "07b2ba21d361c223e25e3c1e924288742923f08c", + "version" : "2.2.1" + } + }, + { + "identity" : "cwlpreconditiontesting", + "kind" : "remoteSourceControl", + "location" : "https://github.com/mattgallagher/CwlPreconditionTesting.git", + "state" : { + "revision" : "0139c665ebb45e6a9fbdb68aabfd7c39f3fe0071", + "version" : "2.2.2" + } + }, { "identity" : "nimble", "kind" : "remoteSourceControl", diff --git a/docs/Classes/Actor.html b/docs/Classes/Actor.html index f1fa8732f..1ca6992a4 100644 --- a/docs/Classes/Actor.html +++ b/docs/Classes/Actor.html @@ -262,7 +262,7 @@

Actor

- 
@objc(SwiftActor)
+                  
@objc(SwiftActor)
 @objcMembers
 public final class Actor : Type

 
diff --git a/docs/Classes/Class.html b/docs/Classes/Class.html
index e4ac3095b..753d2e7a3 100644
--- a/docs/Classes/Class.html
+++ b/docs/Classes/Class.html
@@ -262,7 +262,7 @@ 
Class

               

                 

                   
-                  
@objc(SwiftClass)
+                  
@objc(SwiftClass)
 @objcMembers
 public final class Class : Type

 
diff --git a/docs/Classes/ClosureParameter.html b/docs/Classes/ClosureParameter.html
index b919fe750..36eb4144c 100644
--- a/docs/Classes/ClosureParameter.html
+++ b/docs/Classes/ClosureParameter.html
@@ -374,7 +374,7 @@ 
Declaration

                         
Declaration

                         

                           
Swift

-                          
public let `inout`: Bool

+                          
public let `inout`: Bool

 
                         

                       

diff --git a/docs/Classes/ClosureType.html b/docs/Classes/ClosureType.html
index 5372b0de6..97d43c7f8 100644
--- a/docs/Classes/ClosureType.html
+++ b/docs/Classes/ClosureType.html
@@ -564,7 +564,7 @@ 
Declaration

                         
Declaration

                         

                           
Swift

-                          
public let `throws`: Bool

+                          
public let `throws`: Bool

 
                         

                       

diff --git a/docs/Classes/Method.html b/docs/Classes/Method.html
index fa618dcf1..31ba1d91e 100644
--- a/docs/Classes/Method.html
+++ b/docs/Classes/Method.html
@@ -262,7 +262,7 @@ 
Method

               

                 

                   
-                  
@objc(SwiftMethod)
+                  
@objc(SwiftMethod)
 @objcMembers
 public final class Method : NSObject, SourceryModel, Annotated, Documented, Definition, Diffable

 
extension Method: NSCoding

@@ -646,7 +646,7 @@ 
Declaration

                         
Declaration

                         

                           
Swift

-                          
public let `throws`: Bool

+                          
public let `throws`: Bool

 
                         

                       

@@ -673,7 +673,7 @@ 
Declaration

                         
Declaration

                         

                           
Swift

-                          
public let `rethrows`: Bool

+                          
public let `rethrows`: Bool

 
                         

                       

diff --git a/docs/Classes/MethodParameter.html b/docs/Classes/MethodParameter.html
index 310548e41..bf65df94a 100644
--- a/docs/Classes/MethodParameter.html
+++ b/docs/Classes/MethodParameter.html
@@ -375,7 +375,7 @@ 
Declaration

                         
Declaration

                         

                           
Swift

-                          
public let `inout`: Bool

+                          
public let `inout`: Bool
diff --git a/docs/Classes/Subscript.html b/docs/Classes/Subscript.html index fc295edf2..69a658c75 100644 --- a/docs/Classes/Subscript.html +++ b/docs/Classes/Subscript.html @@ -592,7 +592,7 @@

Declaration

Declaration

Swift

- 
public let `throws`: Bool
+ 
public let `throws`: Bool
@@ -920,7 +920,7 @@

Declaration

returnTypeName: TypeName, accessLevel: (read: AccessLevel, write: AccessLevel) = (.internal, .internal), isAsync: Bool = false, - `throws`: Bool = false, + `throws`: Bool = false, genericParameters: [GenericParameter] = [], genericRequirements: [GenericRequirement] = [], attributes: AttributeList = [:], diff --git a/docs/Classes/TypeName.html b/docs/Classes/TypeName.html index 3c377e0e8..609f132db 100644 --- a/docs/Classes/TypeName.html +++ b/docs/Classes/TypeName.html @@ -965,7 +965,7 @@

Declaration

Declaration

Swift

- 
public convenience init(_ description: String)
+ 
public convenience init(_ description: String)
diff --git a/docs/Classes/Variable.html b/docs/Classes/Variable.html index dc403c232..41dcacee0 100644 --- a/docs/Classes/Variable.html +++ b/docs/Classes/Variable.html @@ -430,7 +430,7 @@

Declaration

Declaration

Swift

- 
public let `throws`: Bool
+ 
public let `throws`: Bool
diff --git a/docs/Other Classes.html b/docs/Other Classes.html index ce6796c5e..be10e2d9e 100644 --- a/docs/Other Classes.html +++ b/docs/Other Classes.html @@ -286,7 +286,7 @@

Other Classes

Declaration

Swift

- 
@objc(SwiftActor)
+                          
@objc(SwiftActor)
 @objcMembers
 public final class Actor : Type

 
diff --git a/docs/Types.html b/docs/Types.html
index c13bd7717..a8d5c9f4d 100644
--- a/docs/Types.html
+++ b/docs/Types.html
@@ -374,7 +374,7 @@ 
Declaration

                         
Declaration

                         

                           
Swift

-                          
@objc(SwiftClass)
+                          
@objc(SwiftClass)
 @objcMembers
 public final class Class : Type

 
@@ -582,7 +582,7 @@ 
Declaration

                         
Declaration

                         

                           
Swift

-                          
@objc(SwiftMethod)
+                          
@objc(SwiftMethod)
 @objcMembers
 public final class Method : NSObject, SourceryModel, Annotated, Documented, Definition, Diffable

 
extension Method: NSCoding

diff --git a/docs/codable.html b/docs/codable.html
index ca6c64921..878f3ef25 100644
--- a/docs/codable.html
+++ b/docs/codable.html
@@ -427,8 +427,8 @@ 
Enums
 
 
For such enum template will generate code that will successfully decode from/encode to JSON of following form:

 
{
-  "value": "someCase"
-  "anotherValue": "anotherCase"
+  "value": "someCase"
+  "anotherValue": "anotherCase"
 }
 

 
@@ -454,9 +454,9 @@ 
Enums with assoicated valu
 
 
If you define a coding key named enumCaseKey then the template will generate code that will encode/decode enum in/from following format:

 
{
-  "type": "someCase" // enum case is encoded in a special key
-  "id": 1,
-  "name": "John"
+  "type": "someCase" // enum case is encoded in a special key
+  "id": 1,
+  "name": "John"
 }
 

 
@@ -464,9 +464,9 @@ 
Enums with assoicated valu
 
 
If you don’t define enumCaseKey then the template will generate code that will encode/decode enum in/from following format:

 
{
-  "someCase": {
-    "id": 1,
-    "name": "John"
+  "someCase": {
+    "id": 1,
+    "name": "John"
   }
 }
 

@@ -474,7 +474,7 @@ 
Enums with assoicated valu
 
Associated values of each enum case must be either all named or all unnamed.
 For cases with unnamed associated values JSON format will use array instead of dictionary for associated values, in the same order in which they are defined:

 
{
-  "someCase": [
+  "someCase": [
     1,
     "Jhon"
   ]
diff --git a/docs/usage.html b/docs/usage.html
index 5239ddca4..676c8397d 100644
--- a/docs/usage.html
+++ b/docs/usage.html
@@ -305,7 +305,7 @@ 
Configuration file

 output:
   <output path> # note that there is no `-` here as only single output path is supported
 args:
-  <name>: <value>
+  <name>: <value>
 

 
Multiple configurations

 
@@ -319,8 +319,8 @@ 
Multiple configurations

         - <templates path>
       output: <output path>
       args:
-        <name>: <value>
-        <name>: <value>
+        <name>: <value>
+        <name>: <value>
     - sources:
         - <sources path>
         - <sources path>
@@ -328,11 +328,20 @@ 
Multiple configurations

         - <templates path>
       output: <output path>
       args:
-        <name>: <value>
-        <name>: <value>
+        <name>: <value>
+        <name>: <value>
 

 
 
This will be equivalent to running Sourcery separately for each of the configurations. In watch mode Sourcery will observe changes in the paths from all the configurations.

+
Child configurations

+
+
You can specify a child configurations by using the child key:

+
configurations:
+    - child: ./.child_config.yml
+    - child: Subdirectory/.another_child_config.yml
+

+
+
Sources will be resolved relative to the child config paths.

 
Sources

 
 
You can provide sources using paths to directories or specific files.

@@ -403,7 +412,7 @@ 
Output

   path: <output path>
   link:
     project: <path to the xcodeproj to link to>
-    target: <name of the target to link to> // or targets: [target1, target2, ...]
+    target: <name of the target to link to> // or targets: [target1, target2, ...]
     group: <group in the project to add files to> // by default files are added to project's root group