javier
0e71b2673c
This PR contains the work done to update the project to use the *Apache v2.0* license. Reviewed-on: #6 Co-authored-by: Javier Cicchelli <javier@rock-n-code.com> Co-committed-by: Javier Cicchelli <javier@rock-n-code.com>
34 lines
1.1 KiB
Swift
34 lines
1.1 KiB
Swift
// ===----------------------------------------------------------------------===
|
|
//
|
|
// This source file is part of the Hummingbird DocC open source project
|
|
//
|
|
// Copyright (c) 2025 Röck+Cöde VoF. and the Hummingbird DocC project authors
|
|
// Licensed under Apache license v2.0
|
|
//
|
|
// See LICENSE for license information
|
|
// See CONTRIBUTORS for the list of Hummingbird DocC project authors
|
|
//
|
|
// SPDX-License-Identifier: Apache-2.0
|
|
//
|
|
// ===----------------------------------------------------------------------===
|
|
|
|
/// An enumeration that represents the documentation folders that could be generated by the `DocC` building process.
|
|
enum DocumentationFolder: String, CaseIterable {
|
|
/// An article document, which can also be used for (source code generated) technical documentation as well.
|
|
case article = "documentation"
|
|
/// A tutorial document.
|
|
case tutorial = "tutorials"
|
|
}
|
|
|
|
// MARK: - Pathable
|
|
|
|
extension DocumentationFolder: Pathable {
|
|
|
|
// MARK: Computed
|
|
|
|
var path: String {
|
|
.init(format: .Format.Path.root, rawValue)
|
|
}
|
|
|
|
}
|