From afd054a58730558d2af414f43182c23ed3b8c5e2 Mon Sep 17 00:00:00 2001
From: David Alarcon <momachilles@gmail.com>
Date: Mon, 22 Feb 2021 16:14:36 +0100
Subject: [PATCH] APPLEMAIL-33 Modify some class and method documentation.

---
 .../Shared/PEPUpdateDownloadXPCApiProtocol.h  | 12 ++++++--
 .../PEPUpdatesXPCService.h                    |  3 +-
 .../Shared/PEPUpdateDownloader.h              |  3 +-
 foundation.pEp.adapter.macOS.plist            | 29 +++++++++++++++++++
 4 files changed, 41 insertions(+), 6 deletions(-)
 create mode 100644 foundation.pEp.adapter.macOS.plist

diff --git a/Submodules/PEPUpdatesXPCService/PEPUpdatesXPCService/PEPUpdateDownloadXPCService/Shared/PEPUpdateDownloadXPCApiProtocol.h b/Submodules/PEPUpdatesXPCService/PEPUpdatesXPCService/PEPUpdateDownloadXPCService/Shared/PEPUpdateDownloadXPCApiProtocol.h
index 5b65962..f004839 100644
--- a/Submodules/PEPUpdatesXPCService/PEPUpdatesXPCService/PEPUpdateDownloadXPCService/Shared/PEPUpdateDownloadXPCApiProtocol.h
+++ b/Submodules/PEPUpdatesXPCService/PEPUpdatesXPCService/PEPUpdateDownloadXPCService/Shared/PEPUpdateDownloadXPCApiProtocol.h
@@ -14,9 +14,15 @@ static NSString *pEpUpdateDownloadXPCMachName = @"foundation.pEp.adapter.macOS_O
 /// Provides the XPC interface for update downloads to pEp updates app.
 @protocol PEPUpdateDownloadXPCApiProtocol
 
-/// Subscribe to the notifications about update downloads status.
-/// @param xpcListenerEndpoint The anonymous endpoint from the update download notification
-/// status service in pEp updates app.
+/// Subscribe to receive notifications about update downloads status.
+/// @param xpcListenerEndpoint The endpoint from the notification status service.
+/// @code
+/// PEPNotificationXPCService *service = [[PEPNotificationXPCService alloc] initWithDelegate:self];
+/// NSXPCListenerEndpoint *endpoint = service.xpcListenerEndpoint;
+///
+/// [self subscribeForUpdate:edpoint];
+/// @endcode
+/// @discussion Method where we combine the two services together
 - (void)subscribeForUpdate:(NSXPCListenerEndpoint*)xpcListenerEndpoint;
 
 /// Unsubscribe from receiving notifications about update downloads status.
diff --git a/Submodules/PEPUpdatesXPCService/PEPUpdatesXPCService/PEPUpdatesXPCService.h b/Submodules/PEPUpdatesXPCService/PEPUpdatesXPCService/PEPUpdatesXPCService.h
index 1e7e0ad..aed7fb6 100644
--- a/Submodules/PEPUpdatesXPCService/PEPUpdatesXPCService/PEPUpdatesXPCService.h
+++ b/Submodules/PEPUpdatesXPCService/PEPUpdatesXPCService/PEPUpdatesXPCService.h
@@ -6,8 +6,7 @@
 //
 
 /// Umbrella for module PEPUpdatesXPCServices
-/// You can import the module in Swift projects: import PEPUpdatesXPCService
-
+/// @code import PEPUpdatesXPCService
 #import <Foundation/Foundation.h>
 
 #import "PEPUpdateDownloadXPCApiProtocol.h"
diff --git a/Submodules/PEPUpdatesXPCService/PEPUpdatesXPCService/Shared/PEPUpdateDownloader.h b/Submodules/PEPUpdatesXPCService/PEPUpdatesXPCService/Shared/PEPUpdateDownloader.h
index a20eaeb..0d6c6a2 100644
--- a/Submodules/PEPUpdatesXPCService/PEPUpdatesXPCService/Shared/PEPUpdateDownloader.h
+++ b/Submodules/PEPUpdatesXPCService/PEPUpdatesXPCService/Shared/PEPUpdateDownloader.h
@@ -25,7 +25,8 @@
 /// Stop schedule the update downloads.
 - (void)stopUpdates;
 
-/// Update download for all pEp products.
+/// Trigger the download of available updates for all installed pEp products.
+/// Informs and notifies the subscriber if there are updates available.
 - (void)updateAll;
 
 @end
diff --git a/foundation.pEp.adapter.macOS.plist b/foundation.pEp.adapter.macOS.plist
new file mode 100644
index 0000000..bb909f0
--- /dev/null
+++ b/foundation.pEp.adapter.macOS.plist
@@ -0,0 +1,29 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE plist PUBLIC "-//Apple Computer//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+<plist version="1.0">
+    <!-- Copyleft (c) 2020 by p≡p foundation -->
+    <!-- this file is under GNU General Public License 3.0 -->
+    <dict>
+        <key>Label</key>
+        <string>foundation.pEp.adapter.macOS</string>
+        <key>ProgramArguments</key>
+        <array>
+          <string>/Library/Application Support/pEp/pEp.app/Contents/MacOS/foundation.pEp.adapter.macOS</string>
+        </array>
+        <key>MachServices</key>
+		    <dict>
+		       <key>pEp.foundation.pEpXPCAdapter_OpenStep</key>
+		       <true/>
+		       <key>foundation.pEp.adapter.macOS_OpenStep</key>
+		       <true/>
+         </dict>
+        <key>StandardOutPath</key>
+        <string>/tmp/foundation.pEp.adapter.macOS.log</string>
+        <key>StandardErrorPath</key>
+        <string>/tmp/foundation.pEp.adapter.macOS.log</string>
+        <key>LimitLoadToSessionType</key>
+        <string>Aqua</string>
+        <key>KeepAlive</key>
+        <true/>
+    </dict>
+</plist>