Browse Source

APPLEMAIL-33 Modify some class and method documentation.

APPLEMAIL-33
David Alarcon 1 year ago
parent
commit
afd054a587
4 changed files with 41 additions and 6 deletions
  1. +9
    -3
      Submodules/PEPUpdatesXPCService/PEPUpdatesXPCService/PEPUpdateDownloadXPCService/Shared/PEPUpdateDownloadXPCApiProtocol.h
  2. +1
    -2
      Submodules/PEPUpdatesXPCService/PEPUpdatesXPCService/PEPUpdatesXPCService.h
  3. +2
    -1
      Submodules/PEPUpdatesXPCService/PEPUpdatesXPCService/Shared/PEPUpdateDownloader.h
  4. +29
    -0
      foundation.pEp.adapter.macOS.plist

+ 9
- 3
Submodules/PEPUpdatesXPCService/PEPUpdatesXPCService/PEPUpdateDownloadXPCService/Shared/PEPUpdateDownloadXPCApiProtocol.h View File

@ -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.


+ 1
- 2
Submodules/PEPUpdatesXPCService/PEPUpdatesXPCService/PEPUpdatesXPCService.h View File

@ -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"


+ 2
- 1
Submodules/PEPUpdatesXPCService/PEPUpdatesXPCService/Shared/PEPUpdateDownloader.h View File

@ -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

+ 29
- 0
foundation.pEp.adapter.macOS.plist View File

@ -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>

Loading…
Cancel
Save