Organization

Sources/Packages/Sources/SecretAgentKit/Documentation.docc/Documentation.md

@@ -1,13 +1,23 @@
 # ``SecretAgentKit``
 
-<!--@START_MENU_TOKEN@-->Summary<!--@END_MENU_TOKEN@-->
-
-## Overview
-
-<!--@START_MENU_TOKEN@-->Text<!--@END_MENU_TOKEN@-->
+SecretAgentKit is a collection of types that allow SecretAgent to conform to the SSH agent protocol.
 
 ## Topics
 
-### <!--@START_MENU_TOKEN@-->Group<!--@END_MENU_TOKEN@-->
+### Agent
 
-- <!--@START_MENU_TOKEN@-->``Symbol``<!--@END_MENU_TOKEN@-->
+- ``Agent``
+
+### Protocol
+
+- ``SSHAgent``
+
+### Request Notification
+
+- ``SigningWitness``
+
+### Socket Operations
+
+- ``SocketController``
+- ``FileHandleReader``
+- ``FileHandleWriter``

Sources/SecretAgent/Notifier.swift

@@ -103,20 +103,9 @@ class Notifier {
 
 extension Notifier: SigningWitness {
 
-    /// <#Description#>
-    /// - Parameters:
-    ///   - secret: <#secret description#>
-    ///   - store: <#store description#>
-    ///   - provenance: <#provenance description#>
     func speakNowOrForeverHoldYourPeace(forAccessTo secret: AnySecret, from store: AnySecretStore, by provenance: SigningRequestProvenance) throws {
     }
 
-    /// <#Description#>
-    /// - Parameters:
-    ///   - secret: <#secret description#>
-    ///   - store: <#store description#>
-    ///   - provenance: <#provenance description#>
-    ///   - requiredAuthentication: <#requiredAuthentication description#>
     func witness(accessTo secret: AnySecret, from store: AnySecretStore, by provenance: SigningRequestProvenance, requiredAuthentication: Bool) throws {
         notify(accessTo: secret, from: store, by: provenance, requiredAuthentication: requiredAuthentication)
     }