Ability to exclude symbols from generated documentation

README.md

@@ -89,19 +89,20 @@ $ apt-get install -y libxml2-dev graphviz
 
     OVERVIEW: Generates Swift documentation
 
-    USAGE: swift doc generate [<inputs> ...] --module-name <module-name> [--output <output>] [--format <format>] [--base-url <base-url>]
+    USAGE: swift doc generate [<inputs> ...] --module-name <module-name> [--output <output>] [--format <format>] [--base-url <base-url>] [--excluded-symbols <excluded-symbols>]
 
     ARGUMENTS:
       <inputs>                One or more paths to Swift files 
 
     OPTIONS:
       -n, --module-name <module-name>
                               The name of the module 
-      -o, --output <output>   The path for generated output (default:
-                              .build/documentation)
+      -o, --output <output>   The path for generated output (default: .build/documentation)
       -f, --format <format>   The output format (default: commonmark)
-      --base-url <base-url>   The base URL used for all relative URLs in generated
-                              documents. (default: /)
+      --base-url <base-url>   The base URL used for all relative URLs in generated documents. (default: /)
+      --excluded-symbols <excluded-symbols>
+                              A file containing a line separated list of symbols to be excluded from the generated documentation 
+      --version               Show the version.
       -h, --help              Show help information.
 
 The `generate` subcommand 

Sources/SwiftDoc/Module.swift

@@ -7,16 +7,16 @@ public final class Module {
     public let sourceFiles: [SourceFile]
     public let interface: Interface
 
-    public required init(name: String = "Anonymous", sourceFiles: [SourceFile]) {
+    public required init(name: String = "Anonymous", sourceFiles: [SourceFile], exclusions: [String] = []) {
         self.name = name
         self.sourceFiles = sourceFiles
 
         let imports = sourceFiles.flatMap { $0.imports }
-        let symbols = sourceFiles.flatMap { $0.symbols }
+        let symbols = sourceFiles.flatMap { $0.symbols }.filter({ !exclusions.contains($0.name) })
         self.interface = Interface(imports: imports, symbols: symbols)
     }
 
-    public convenience init(name: String = "Anonymous", paths: [String]) throws {
+    public convenience init(name: String = "Anonymous", paths: [String], exclusionsFilePath: String? = nil) throws {
         var sources: [(file: URL, directory: URL)] = []
 
         let fileManager = FileManager.default
@@ -34,8 +34,12 @@ public final class Module {
             }
         }
 
+        var excludedSymbols = [String]()
+        if let exclusionsFilePath = exclusionsFilePath {
+          excludedSymbols = try String(contentsOfFile: exclusionsFilePath).components(separatedBy: "\n").filter { !$0.isEmpty }
+        }
         let sourceFiles = try sources.parallelMap { try SourceFile(file: $0.file, relativeTo: $0.directory) }
 
-        self.init(name: name, sourceFiles: sourceFiles)
+        self.init(name: name, sourceFiles: sourceFiles, exclusions: excludedSymbols)
     }
 }

Sources/swift-doc/Subcommands/Generate.swift

@@ -34,7 +34,13 @@ extension SwiftDoc {
 
       @Option(name: .customLong("base-url"),
               help: "The base URL used for all relative URLs in generated documents.")
+
       var baseURL: String = "/"
+
+      @Option(name: .customLong("excluded-symbols"),
+              default: nil,
+              help: "A file containing a line separated list of symbols to be excluded from the generated documentation")
+      var exclusionsFilePath: String?
     }
 
     static var configuration = CommandConfiguration(abstract: "Generates Swift documentation")
@@ -43,7 +49,7 @@ extension SwiftDoc {
     var options: Options
 
     func run() throws {
-      let module = try Module(name: options.moduleName, paths: options.inputs)
+      let module = try Module(name: options.moduleName, paths: options.inputs, exclusionsFilePath: options.exclusionsFilePath)
       let baseURL = options.baseURL
 
       let outputDirectoryURL = URL(fileURLWithPath: options.output)

action.yml

@@ -20,6 +20,8 @@ inputs:
     description: "The path for generated output"
     required: true
     default: "./.build/documentation"
+  excluded-symbols:
+    description: "File containing a list of symbols to exclude from the generated documenttion"
 
 runs:
   using: "docker"
@@ -36,6 +38,8 @@ runs:
       "${{ inputs.module-name }}",
       --output,
       "${{ inputs.output }}",
+      --excluded-symbols,
+      "${{ inputs.excluded-symbols }}",
     ]
 
 branding: