ENGINE-423 doc fixes
authorKrista Bennett <krista@pep-project.org>
Tue, 08 May 2018 10:38:57 +0200
changeset 2658b9d02eaf6b90
parent 2656 f8d31769b769
child 2659 5d0dcfb29de6
ENGINE-423 doc fixes
src/message_api.h
     1.1 --- a/src/message_api.h	Mon May 07 17:45:50 2018 +0200
     1.2 +++ b/src/message_api.h	Tue May 08 10:38:57 2018 +0200
     1.3 @@ -12,8 +12,8 @@
     1.4  extern "C" {
     1.5  #endif
     1.6  
     1.7 -
     1.8  bool import_attached_keys(
     1.9 +    
    1.10          PEP_SESSION session, 
    1.11          const message *msg,
    1.12          identity_list **private_idents
    1.13 @@ -269,7 +269,7 @@
    1.14  //      session (in)        session handle
    1.15  //      src (inout)         message to decrypt
    1.16  //      dst (out)           pointer to new decrypted message or NULL on failure
    1.17 -//      keylist (inout)     in: stringlist with additional keys for reencryption if needed
    1.18 +//      keylist (inout)     in: stringlist with additional keyids for reencryption if needed
    1.19  //                              (will be freed and replaced with output keylist) 
    1.20  //                          out: stringlist with keyids
    1.21  //      rating (out)        rating for the message
    1.22 @@ -329,7 +329,9 @@
    1.23  //      mimetext (in)           MIME encoded text to decrypt
    1.24  //      size (in)               size of mime text to decode (in order to decrypt)
    1.25  //      mime_plaintext (out)    decrypted, encoded message
    1.26 -//      keylist (out)           stringlist with keyids
    1.27 +//      keylist (inout)         in: stringlist with additional keyids for reencryption if needed
    1.28 +//                                  (will be freed and replaced with output keylist)
    1.29 +//                              out: stringlist with keyids
    1.30  //      rating (out)            rating for the message
    1.31  //      flags (inout)           flags to signal special decryption features (see below)
    1.32  //      modified_src (out)      modified source string, if decrypt had reason to change it