Merge pull request #5 from markbattistella/2024.03.26-cleanup

2024-03-26 - Comment cleanup
markbattistella · Mar 25, 2024 · eb79c49 · eb79c49
2 parents ab2150d + f2c8fbd
commit eb79c49
Show file tree

Hide file tree

Showing 14 changed files with 55 additions and 49 deletions.
diff --git a/Documentation/index.html b/Documentation/index.html
@@ -2,41 +2,30 @@
 <html lang="en">
 <head>
 	<title>ZodiacKit: Apple Swift Package</title>
-
 	<meta charset="UTF-8">
 	<meta name="description" content="ZodiacKit is a Swift package that allows you to fetch Western and Chinese Zodiac Sign information based on a given date. It provides a simple, efficient, and easily integrable solution for applications that deal with astrological data.">
 	<meta name="viewport" content="width=device-width, user-scalable=no, initial-scale=1.0, maximum-scale=1.0, minimum-scale=1.0">
-
-	<!-- theme: simple -->
 	<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/docsify-themeable@0/dist/css/theme-simple-dark.css">
 	<link rel="stylesheet" href="style.min.css">
-
 </head>
-
 <body>
-
 	<div id="app"></div>
-
 	<script>
 	window.$docsify = {
-		name:						'ZodiacKit',
-		repo:						'https://github.com/markbattistella/ZodiacKit',
-		homepage:				'https://raw.githubusercontent.com/markbattistella/ZodiacKit/main/README.md',
-		auto2top:				true,
-		notFoundPage:		'404.md',
-		relativePath:		false,
-		coverpage:			false,
-		loadNavbar:			false,
-		loadSidebar:		false,
-		hideSidebar:		true,
-		nativeEmoji: 		true,
-		themeColor:			'var(--mb-colour-purple)'
+		name: 'ZodiacKit',
+		repo: 'https://github.com/markbattistella/ZodiacKit',
+		homepage: 'https://raw.githubusercontent.com/markbattistella/ZodiacKit/main/README.md',
+		auto2top: true,
+		notFoundPage: '404.md',
+		relativePath: false,
+		coverpage: false,
+		loadNavbar: false,
+		loadSidebar: false,
+		hideSidebar: true,
+		nativeEmoji: true,
+		themeColor: 'var(--mb-colour-purple)'
 	}
 	</script>
-
-	<!-- docsify.js -->
 	<script src="https://cdn.jsdelivr.net/npm/docsify@latest"></script>
-
-
 </body>
-</html>
+</html>
diff --git a/Sources/ZodiacKit/Defaults/DefaultZodiacs.swift b/Sources/ZodiacKit/Defaults/DefaultZodiacs.swift
@@ -1,6 +1,7 @@
 //
-//  ZodiacKit
-//  Created by Mark Battistella
+// Project: ZodiacKit
+// Author: Mark Battistella
+// Website: https://markbattistella.com
 //
 
 import Foundation

diff --git a/Sources/ZodiacKit/Error/ZodiacError.swift b/Sources/ZodiacKit/Error/ZodiacError.swift
@@ -1,6 +1,7 @@
 //
-//  ZodiacKit
-//  Created by Mark Battistella
+// Project: ZodiacKit
+// Author: Mark Battistella
+// Website: https://markbattistella.com
 //
 
 import Foundation

diff --git a/Sources/ZodiacKit/Helper/DateValidator.swift b/Sources/ZodiacKit/Helper/DateValidator.swift
@@ -1,6 +1,7 @@
 //
-//  ZodiacKit
-//  Created by Mark Battistella
+// Project: ZodiacKit
+// Author: Mark Battistella
+// Website: https://markbattistella.com
 //
 
 import Foundation

diff --git a/Sources/ZodiacKit/Model/ChineseZodiacSign.swift b/Sources/ZodiacKit/Model/ChineseZodiacSign.swift
@@ -1,6 +1,7 @@
 //
-//  ZodiacKit
-//  Created by Mark Battistella
+// Project: ZodiacKit
+// Author: Mark Battistella
+// Website: https://markbattistella.com
 //
 
 import Foundation

diff --git a/Sources/ZodiacKit/Model/WesternZodiac.swift b/Sources/ZodiacKit/Model/WesternZodiac.swift
@@ -1,6 +1,7 @@
 //
-//  ZodiacKit
-//  Created by Mark Battistella
+// Project: ZodiacKit
+// Author: Mark Battistella
+// Website: https://markbattistella.com
 //
 
 import Foundation

diff --git a/Sources/ZodiacKit/Model/WesternZodiacSign.swift b/Sources/ZodiacKit/Model/WesternZodiacSign.swift
@@ -1,6 +1,7 @@
 //
-//  ZodiacKit
-//  Created by Mark Battistella
+// Project: ZodiacKit
+// Author: Mark Battistella
+// Website: https://markbattistella.com
 //
 
 #if canImport(UIKit)

diff --git a/Sources/ZodiacKit/Protocol/Validator.swift b/Sources/ZodiacKit/Protocol/Validator.swift
@@ -1,6 +1,7 @@
 //
-//  ZodiacKit
-//  Created by Mark Battistella
+// Project: ZodiacKit
+// Author: Mark Battistella
+// Website: https://markbattistella.com
 //
 
 import Foundation

diff --git a/Sources/ZodiacKit/Protocol/ZodiacSign.swift b/Sources/ZodiacKit/Protocol/ZodiacSign.swift
@@ -1,12 +1,17 @@
 //
-// Project: 
+// Project: ZodiacKit
 // Author: Mark Battistella
 // Website: https://markbattistella.com
 //
 
 import Foundation
 
+/// A protocol to conform `WesternZodiacSign` and `ChineseZodiacSign`.
 protocol ZodiacSign: CaseIterable, Codable, RawRepresentable where RawValue == String {
+
+    /// Requires a name
     var name: String { get }
+
+    /// Requires an emoji
     var emoji: String { get }
 }
diff --git a/Sources/ZodiacKit/Services/ZodiacService.swift b/Sources/ZodiacKit/Services/ZodiacService.swift
@@ -1,6 +1,7 @@
 //
-//  ZodiacKit
-//  Created by Mark Battistella
+// Project: ZodiacKit
+// Author: Mark Battistella
+// Website: https://markbattistella.com
 //
 
 import Foundation

diff --git a/Tests/ZodiacKitTests/ChineseAttributes.swift b/Tests/ZodiacKitTests/ChineseAttributes.swift
@@ -1,6 +1,7 @@
 //
-//  ZodiacKit
-//  Created by Mark Battistella
+// Project: ZodiacKit
+// Author: Mark Battistella
+// Website: https://markbattistella.com
 //
 
 import XCTest

diff --git a/Tests/ZodiacKitTests/Dates.swift b/Tests/ZodiacKitTests/Dates.swift
@@ -1,6 +1,7 @@
 //
-//  ZodiacKit
-//  Created by Mark Battistella
+// Project: ZodiacKit
+// Author: Mark Battistella
+// Website: https://markbattistella.com
 //
 
 import XCTest

diff --git a/Tests/ZodiacKitTests/Setup.swift b/Tests/ZodiacKitTests/Setup.swift
@@ -1,6 +1,7 @@
 //
-//  ZodiacKit
-//  Created by Mark Battistella
+// Project: ZodiacKit
+// Author: Mark Battistella
+// Website: https://markbattistella.com
 //
 
 import XCTest

diff --git a/Tests/ZodiacKitTests/WesternAttributes.swift b/Tests/ZodiacKitTests/WesternAttributes.swift
@@ -1,6 +1,7 @@
 //
-//  ZodiacKit
-//  Created by Mark Battistella
+// Project: ZodiacKit
+// Author: Mark Battistella
+// Website: https://markbattistella.com
 //
 
 import XCTest