Changeset 312

Show
Ignore:
Timestamp:
11/28/05 13:15:38
Author:
ben
Message:

Documentation tweaks.

Files:

Legend:

Unmodified
Added
Removed
Modified
Copied
Moved

  • openpgpsdk/trunk/src/fingerprint.c

    r311 r312  
    1212# include <alloca.h> 
    1313#endif 
     14 
     15/** 
     16 * \ingroup Utils 
     17 * 
     18 * Calculate a public key fingerprint. 
     19 * 
     20 * \param fp Where to put the calculated fingerprint 
     21 * \param key The key for which the fingerprint is calculated 
     22 */ 
    1423 
    1524void ops_fingerprint(ops_fingerprint_t *fp,const ops_public_key_t *key) 
    …… 
    6675 * \ingroup Utils 
    6776 * 
    68  * Not sure what this does 
     77 * Calculate the Key ID from the public key. 
    6978 * 
    70  * \param keyid 
    71  * \param key 
    72  * 
    73  * \todo Get descr from Ben for ops_keyid() 
     79 * \param keyid Space for the calculated ID to be stored 
     80 * \param key The key for which the ID is calculated 
    7481 */ 
    7582 

  • openpgpsdk/trunk/src/util.c

    r307 r312  
    5757 * \ingroup Utils 
    5858 * 
    59  * ops_init() just calls ops_crypto_init() 
    60  * \todo Ask Ben why we need this extra layer 
     59 * Initialise OpenPGP:SDK. This <b>must</b> be called before any other 
     60 * OpenPGP:SDK function is used. 
    6161 */ 
    6262 
    …… 
    6969 * \ingroup Utils 
    7070 * 
    71  * ops_finish() just calls ops_crypto_finish() 
    72  * \todo Ask Ben why we need this extra layer 
     71 * Close down OpenPGP:SDK, release any resources under the control of 
     72 * the library. No OpenPGP:SDK function other than ops_init() should 
     73 * be called after this function. 
    7374 */ 
    7475