IOSAD-160 Add whitespace to docs IOSAD-160
authorDirk Zimmermann <dz@pep.security>
Tue, 03 Dec 2019 14:07:27 +0100
branchIOSAD-160
changeset 13713fa5bcebb17b
parent 1370 d8d271b0bab8
child 1372 ac119be204d2
IOSAD-160 Add whitespace to docs
pEpObjCAdapterFramework/PEPSessionProtocol.h
     1.1 --- a/pEpObjCAdapterFramework/PEPSessionProtocol.h	Tue Dec 03 14:07:27 2019 +0100
     1.2 +++ b/pEpObjCAdapterFramework/PEPSessionProtocol.h	Tue Dec 03 14:07:27 2019 +0100
     1.3 @@ -86,22 +86,31 @@
     1.4                                            error:(NSError * _Nullable * _Nullable)error;
     1.5  
     1.6  /// Marks an identity as an own identity.
     1.7 +///
     1.8  /// @return Returns YES on success, NO on error, setting `*error` accordingly if possible.
     1.9 +///
    1.10  /// @note See the engine's myself function for details.
    1.11 +///
    1.12  /// @param identity The identity to mark as own.
    1.13 +///
    1.14  /// @param pEpSyncEnabled Whether to enable sync, or not. Will set PEP_idf_not_for_sync
    1.15  /// accordingly.
    1.16 +///
    1.17  /// @param error Standard cocoa error handling.
    1.18  - (BOOL)mySelf:(PEPIdentity * _Nonnull)identity
    1.19  pEpSyncEnabled:(BOOL)pEpSyncEnabled
    1.20           error:(NSError * _Nullable * _Nullable)error;
    1.21  
    1.22  /// Calls the engine's update_identity on the given identity.
    1.23 +///
    1.24  /// @note Prior this was invoking myself if the identity was identified as being an own
    1.25  /// identity, but this not the case anymore, since it cannot decide if the identity should
    1.26  /// participate in pEp sync or not.
    1.27 +///
    1.28  /// @return Returns YES on success, NO on error, setting `*error` accordingly if possible.
    1.29 +///
    1.30  /// @param identity The identity for which to call update_identity.
    1.31 +/// 
    1.32  /// @param error Standart cocoa error handling.
    1.33  - (BOOL)updateIdentity:(PEPIdentity * _Nonnull)identity
    1.34                   error:(NSError * _Nullable * _Nullable)error;