feat: Adds some documenation comments
This commit is contained in:
@@ -4,6 +4,9 @@ import Foundation
|
||||
|
||||
public extension SiteRoute {
|
||||
|
||||
/// Represents api routes that can be interacted with.
|
||||
///
|
||||
/// These routes return json information, as opposed to html like the view routes.
|
||||
enum Api: Sendable, Equatable {
|
||||
|
||||
case employee(EmployeeRoute)
|
||||
|
||||
@@ -2,6 +2,7 @@ import CasePathsCore
|
||||
import Foundation
|
||||
@preconcurrency import URLRouting
|
||||
|
||||
/// Represents all the routes that our server can handle.
|
||||
public enum SiteRoute: Sendable {
|
||||
case api(SiteRoute.Api)
|
||||
case health
|
||||
|
||||
@@ -4,6 +4,10 @@ import Foundation
|
||||
|
||||
public extension SiteRoute {
|
||||
// swiftlint:disable type_body_length
|
||||
|
||||
/// Represents view routes that can be interacted with.
|
||||
///
|
||||
/// These routes return html and are used to generate the web interface.
|
||||
enum View: Sendable, Equatable {
|
||||
|
||||
case employee(SiteRoute.View.EmployeeRoute)
|
||||
|
||||
Reference in New Issue
Block a user