add documentation for certain functions

Author: matthewbastien

Sources/DocCDocumentation/BuildSystemIntegrationExtensions.swift

@@ -19,6 +19,12 @@ import SKLogging
 package extension BuildSystemManager {
   /// Retrieves the name of the Swift module for a given target.
   ///
+  /// **Note:** prefer using ``module(for:in:)`` over ths function. This function
+  /// only exists for cases where you want the Swift module name of a target where
+  /// you don't know one of its Swift document URIs in advance. E.g. when handling
+  /// requests for Markdown/Tutorial files in DocC since they don't have compile
+  /// commands that could be used to find the module name.
+  ///
   /// - Parameter target: The build target identifier
   /// - Returns: The name of the Swift module or nil if it could not be determined
   func moduleName(for target: BuildTargetIdentifier) async -> String? {

Sources/SourceKitLSP/Documentation/DoccDocumentationHandler.swift

@@ -100,11 +100,13 @@ extension DocumentationLanguageService {
       }
       // This is a page representing the module itself.
       // Create a dummy symbol graph and tell SwiftDocC to convert the module name.
+      // The version information isn't really all that important since we're creating
+      // what is essentially an empty symbol graph.
       let emptySymbolGraph = String(
         data: try JSONEncoder().encode(
           SymbolGraph(
             metadata: SymbolGraph.Metadata(
-              formatVersion: SymbolGraph.SemanticVersion(major: 0, minor: 5, patch: 0),
+              formatVersion: SymbolGraph.SemanticVersion(major: 0, minor: 0, patch: 0),
               generator: "SourceKit-LSP"
             ),
             module: SymbolGraph.Module(name: moduleName, platform: SymbolGraph.Platform()),