some pgp_sequoia.h doc doxygen_doc
authorKrista 'DarthMama' Bennett <krista@pep.foundation>
Tue, 08 Sep 2020 22:57:42 +0200
branchdoxygen_doc
changeset 5041b18a508cd543
parent 5040 5eee814b9a91
child 5042 13df5515e514
some pgp_sequoia.h doc
src/pgp_sequoia.h
     1.1 --- a/src/pgp_sequoia.h	Tue Sep 08 22:52:08 2020 +0200
     1.2 +++ b/src/pgp_sequoia.h	Tue Sep 08 22:57:42 2020 +0200
     1.3 @@ -17,20 +17,23 @@
     1.4  /**
     1.5   *  <!--       pgp_init()       -->
     1.6   *  
     1.7 - *  @brief			TODO
     1.8 + *  @brief      initialise the sequoia driver for this session
     1.9   *  
    1.10   *  @param[in]	session		PEP_SESSION
    1.11 - *  @param[in]	in_first		bool
    1.12 + *  @param[in]	in_first    true if this is the first pEp session running
    1.13 + *                          after startup, else false
    1.14   *  
    1.15   */
    1.16  PEP_STATUS pgp_init(PEP_SESSION session, bool in_first);
    1.17 +
    1.18  /**
    1.19   *  <!--       pgp_release()       -->
    1.20   *  
    1.21 - *  @brief			TODO
    1.22 + *  @brief      release resources used by the sequoia driver in this session
    1.23   *  
    1.24   *  @param[in]	session		PEP_SESSION
    1.25 - *  @param[in]	out_last		bool
    1.26 + *  @param[in]	out_last	true if this is the last extant pEp session
    1.27 + *                          running, else false
    1.28   *  
    1.29   */
    1.30  void pgp_release(PEP_SESSION session, bool out_last);