IOSAD-157 New doc style IOSAD-157
authorDirk Zimmermann <dz@pep.security>
Wed, 20 Nov 2019 16:39:59 +0100
branchIOSAD-157
changeset 13541b855c066fd1
parent 1353 4f22ccb02830
child 1355 4b9fe45edb44
IOSAD-157 New doc style
pEpObjCAdapterFramework/PEPNotifyHandshakeDelegate.h
     1.1 --- a/pEpObjCAdapterFramework/PEPNotifyHandshakeDelegate.h	Wed Nov 20 16:39:59 2019 +0100
     1.2 +++ b/pEpObjCAdapterFramework/PEPNotifyHandshakeDelegate.h	Wed Nov 20 16:39:59 2019 +0100
     1.3 @@ -17,24 +17,22 @@
     1.4   */
     1.5  @protocol PEPNotifyHandshakeDelegate <NSObject>
     1.6  
     1.7 -/**
     1.8 - Requests the app to show a handshake dialog, or change the icon that represents
     1.9 - the key-sync state (as in, grouped, or sole, etc.).
    1.10 -
    1.11 - After the dialog has been shown, the user's choices can be communicated back to the engine
    1.12 - via [PEPSessionProtocol deliverHandshakeResult:identitiesSharing:error].
    1.13 -
    1.14 - @param object This can be used to thread information from the app through the sync-loop back to
    1.15 -               the app. Currently unused and always nil.
    1.16 - @param me The own identity.
    1.17 -           Note that in some cases, only the most essential properties are set.
    1.18 - @param partner The partner identity.
    1.19 -                Note that in some cases, only the most essential properties are set.
    1.20 - @param signal The kind of action that is happening or requested.
    1.21 - @return A status indicating errors in the immediate/synchronous handling of the call.
    1.22 -         The (delayed) response from the user are communicated to the engine
    1.23 -         via separate method calls, as noted in the discussion.
    1.24 - */
    1.25 +/// Requests the app to show a handshake dialog, or change the icon that represents
    1.26 +/// the key-sync state (as in, grouped, or sole, etc.).
    1.27 +///
    1.28 +/// After the dialog has been shown, the user's choices can be communicated back to the engine
    1.29 +/// via [PEPSessionProtocol deliverHandshakeResult:identitiesSharing:error].
    1.30 +///
    1.31 +/// @param object This can be used to thread information from the app through the sync-loop back to
    1.32 +///   the app. Currently unused and always nil.
    1.33 +/// @param me The own identity.
    1.34 +///   Note that in some cases, only the most essential properties are set.
    1.35 +/// @param partner The partner identity.
    1.36 +///   Note that in some cases, only the most essential properties are set.
    1.37 +/// @param signal The kind of action that is happening or requested.
    1.38 +/// @return A status indicating errors in the immediate/synchronous handling of the call.
    1.39 +///   The (delayed) response from the user are communicated to the engine
    1.40 +///   via separate method calls, as noted in the discussion.
    1.41  - (PEPStatus)notifyHandshake:(void * _Nullable)object
    1.42                            me:(PEPIdentity * _Nonnull)me
    1.43                       partner:(PEPIdentity * _Nonnull)partner