Changeset 417

Show
Ignore:
Timestamp:
04/28/06 11:30:38
Author:
rachel
Message:

Doxygen comments
Refs #12

Files:

Legend:

Unmodified
Added
Removed
Modified
Copied
Moved
  • openpgpsdk/trunk/examples/create-signed-key.c

    r371 r417  
    4141        } 
    4242 
    43     user_id=argv[1]; 
     43    user_id=(unsigned char *)argv[1]; 
    4444    secfile=argv[2]; 
    4545    pubfile=argv[3]; 
  • openpgpsdk/trunk/include/openpgpsdk/crypto.h

    r397 r417  
    4040typedef void ops_decrypt_finish_t(ops_decrypt_t *decrypt); 
    4141 
     42/** _ops_decrypt_t */ 
    4243struct _ops_decrypt_t 
    4344    { 
  • openpgpsdk/trunk/include/openpgpsdk/packet.h

    r397 r417  
    347347    } ops_rsa_secret_key_t; 
    348348 
     349/** ops_dsa_secret_key_t */ 
    349350typedef struct 
    350351    { 
     
    352353    } ops_dsa_secret_key_t; 
    353354 
    354 /** ops_secret_key_union_t 
    355  */  
     355/** ops_secret_key_union_t */  
    356356typedef struct 
    357357    { 
     
    812812    } ops_pk_session_key_version_t; 
    813813 
     814/** ops_pk_session_key_parameters_rsa_t */ 
    814815typedef struct 
    815816    { 
     
    818819    } ops_pk_session_key_parameters_rsa_t; 
    819820 
     821/** ops_pk_session_key_parameters_elgamal_t */ 
    820822typedef struct 
    821823    { 
     
    824826    } ops_pk_session_key_parameters_elgamal_t; 
    825827 
     828/** ops_pk_session_key_parameters_t */ 
    826829typedef union 
    827830    { 
     
    830833    } ops_pk_session_key_parameters_t; 
    831834 
     835/** ops_pk_session_key_t */ 
    832836typedef struct 
    833837    { 
     
    841845    } ops_pk_session_key_t; 
    842846 
     847/** ops_secret_key_passphrase_t */ 
    843848typedef struct 
    844849    { 
     
    852857    } ops_se_ip_version_t; 
    853858 
     859/** ops_se_ip_data_header_t */ 
    854860typedef struct 
    855861    { 
     
    857863    } ops_se_ip_data_header_t; 
    858864 
     865/** ops_se_data_body_t */ 
    859866typedef struct 
    860867    { 
     
    863870    } ops_se_data_body_t; 
    864871 
     872/** ops_get_secret_key_t */ 
    865873typedef struct 
    866874    { 
  • openpgpsdk/trunk/src/accumulate.c

    r396 r417  
    147147 
    148148// XXX: note necessarily a maintained part of the API. 
     149/** ops_dump_keyring 
     150    \todo decide whether this is part of the API or not 
     151*/ 
    149152void ops_dump_keyring(const ops_keyring_t *keyring) 
    150153    { 
  • openpgpsdk/trunk/src/armour.c

    r412 r417  
    2020 
    2121/** 
    22  * \struct 
     22 * \struct dearmour_arg_t 
    2323 */ 
    2424typedef struct 
     
    172172 
    173173/** 
    174  * \param ops_headers_t 
     174 * \param headers 
    175175 * \param key 
    176176 * 
     
    754754 
    755755/** 
     756 * \brief  
    756757 * \param parse_info Usual structure containing information about to how to do the parse 
    757758 * \param without_gap Allow headers in armoured data that are not separated from the data by a blank line 
     
    786787 
    787788/** 
    788  * \struct 
     789 * \struct dash_escaped_arg_t 
    789790 */ 
    790791typedef struct 
     
    884885 
    885886/** 
    886  * \struct 
     887 * \struct base64_arg_t 
    887888 */ 
    888889typedef struct 
     
    978979 
    979980/** 
    980  * \struct 
     981 * \struct linebreak_arg_t 
    981982 */ 
    982983typedef struct 
  • openpgpsdk/trunk/src/keyring_local.h

    r336 r417  
    99                                } while(0) 
    1010 
     11/** ops_key_data_key_t 
     12 */ 
    1113typedef union 
    1214    { 
     
    1719 
    1820// XXX: gonna have to expand this to hold onto subkeys, too... 
     21/** \struct ops_key_data 
     22 * \todo expand to hold onto subkeys 
     23 */ 
    1924struct ops_key_data 
    2025    { 
  • openpgpsdk/trunk/src/parse_local.h

    r397 r417  
     1/** \file */ 
     2 
     3/** ops_reader_info */ 
    14struct ops_reader_info 
    25    { 
     
    1720    }; 
    1821 
     22/** ops_parse_cb_info */ 
    1923struct ops_parse_cb_info 
    2024    { 
     
    2529    }; 
    2630 
     31/** ops_parse_hash_info_t */ 
    2732typedef struct 
    2833    {