File: Docc.swift

package info (click to toggle)
swiftlang 6.1.3-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 2,791,532 kB
  • sloc: cpp: 9,901,743; ansic: 2,201,431; asm: 1,091,827; python: 308,252; objc: 82,166; f90: 80,126; lisp: 38,358; pascal: 25,559; sh: 20,429; ml: 5,058; perl: 4,745; makefile: 4,484; awk: 3,535; javascript: 3,018; xml: 918; fortran: 664; cs: 573; ruby: 396
file content (44 lines) | stat: -rw-r--r-- 1,470 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
/*
 This source file is part of the Swift.org open source project

 Copyright (c) 2021-2024 Apple Inc. and the Swift project authors
 Licensed under Apache License v2.0 with Runtime Library Exception

 See https://swift.org/LICENSE.txt for license information
 See https://swift.org/CONTRIBUTORS.txt for Swift project authors
*/

import ArgumentParser

private var subcommands: [AsyncParsableCommand.Type] {
    var subcommands: [AsyncParsableCommand.Type] = [
        Docc.Convert.self,
        Docc.ProcessArchive.self,
        Docc.ProcessCatalog.self,
        Docc._Index.self,
        Docc.Init.self,
        Docc.Merge.self,
    ]
#if canImport(NIOHTTP1)
    subcommands.insert(Docc.Preview.self, at: 1)
#endif
    return subcommands
}

private var usage: String {
    var usage = "docc convert [<catalog-path>] [--additional-symbol-graph-dir <symbol-graph-dir>] [<other-options>]"
#if canImport(NIOHTTP1)
    usage.append("\ndocc preview [<catalog-path>] [--port <port-number>] [--additional-symbol-graph-dir <symbol-graph-dir>] [--output-dir <output-dir>] [<other-options>]")
#endif
    return usage
}

/// The default, command-line interface you use to compile and preview documentation.
public struct Docc: AsyncParsableCommand {
    public static var configuration = CommandConfiguration(
        abstract: "Documentation Compiler: compile, analyze, and preview documentation.",
        usage: usage,
        subcommands: subcommands)

    public init() {}
}