Changeset 636

Show
Ignore:
Timestamp:
01/06/09 16:01:17
Author:
rachel
Message:

Better hierarchy in documentation.
Removed some unwanted todos.

Files:

Legend:

Unmodified
Added
Removed
Modified
Copied
Moved

  • openpgpsdk/trunk/include/openpgpsdk/types.h

    r626 r636  
    5858typedef enum ops_content_tag_t ops_packet_tag_t; 
    5959/** SS types are a subset of all content types. 
    60  \todo may be want to separate these out? 
    6160*/ 
    6261typedef enum ops_content_tag_t ops_ss_type_t; 

  • openpgpsdk/trunk/src/doxygen.c

    r625 r636  
    144144*/ 
    145145 
    146 /** 
    147    \defgroup HighLevel_Functions High Level API Functions 
    148    \ingroup HighLevelAPI 
    149 */ 
    150  
    151146/** \defgroup HighLevel_Sign Sign File or Buffer 
    152     \ingroup HighLevel_Functions 
     147    \ingroup HighLevelAPI 
    153148 */ 
    154149     
    155150/** \defgroup HighLevel_Verify Verify File, Buffer, Key or Keyring 
    156     \ingroup HighLevel_Functions 
     151    \ingroup HighLevelAPI 
    157152 */ 
    158153     
    159154/** \defgroup HighLevel_Crypto Encrypt or Decrypt File 
    160     \ingroup HighLevel_Functions 
     155    \ingroup HighLevelAPI 
    161156 */ 
    162157     
    163158/** 
    164159    \defgroup HighLevel_Keyring Keys and Keyrings 
    165     \ingroup HighLevel_Functions 
     160    \ingroup HighLevelAPI 
    166161*/ 
    167162 
    168163/** \defgroup HighLevel_Supported Supported Algorithms 
    169     \ingroup HighLevel_Functions 
     164    \ingroup HighLevelAPI 
    170165 */ 
    171166     
    172167/** \defgroup HighLevel_Memory Memory 
    173     \ingroup HighLevel_Functions 
     168    \ingroup HighLevelAPI 
    174169 */ 
    175170     
    176171/** 
    177172    \defgroup HighLevel_General General 
    178     \ingroup HighLevel_Functions 
     173    \ingroup HighLevelAPI 
    179174*/ 
    180175 
    …… 
    225220/** 
    226221   \defgroup HighLevel_Callbacks Callbacks 
    227    \ingroup HighLevel_Functions 
     222   \ingroup HighLevelAPI 
    228223*/ 
    229224 

  • openpgpsdk/trunk/src/lib/accumulate.c

    r621 r636  
    184184    } 
    185185 
    186 // XXX: note necessarily a maintained part of the API. 
     186// XXX: not a maintained part of the API - use ops_keyring_list() 
    187187/** ops_dump_keyring 
    188     \todo decide whether this is part of the API or not 
    189188*/ 
    190189void ops_dump_keyring(const ops_keyring_t *keyring) 

  • openpgpsdk/trunk/src/lib/create.c

    r625 r636  
    103103 * 
    104104 * \return return value from ops_write_struct_user_id() 
    105  * \todo better descr of return value 
    106105 */ 
    107106ops_boolean_t ops_write_user_id(const unsigned char *user_id,ops_create_info_t *info) 

  • openpgpsdk/trunk/src/lib/fingerprint.c

    r621 r636  
    112112 * \param keyid Space for the calculated ID to be stored 
    113113 * \param key The key for which the ID is calculated 
    114  * \todo add error return value 
    115114 */ 
    116115 

  • openpgpsdk/trunk/src/lib/packet-show.c

    r627 r636  
    563563 * 
    564564 * returns description of the Revocation Reason code 
    565  * \todo add reference 
    566  * \todo make typesafe 
     565 * \param ss_rr_code Revocation Reason code 
    567566 * \return string or "Unknown" 
    568567 */ 
    …… 
    577576 * returns description of the given Signature type 
    578577 * \param sig_type Signature type 
    579  * \todo add reference 
    580578 * \return string or "Unknown" 
    581579 */ 
    …… 
    590588 * returns description of the given Public Key Algorithm 
    591589 * \param pka Public Key Algorithm type 
    592  * \todo add reference 
    593590 * \return string or "Unknown" 
    594591 */ 
    …… 
    601598 * \ingroup Core_Print 
    602599 * returns description of the Preferred Compression 
    603  * \param octet 
     600 * \param octet Preferred Compression 
    604601 * \return string or "Unknown" 
    605602*/ 
    …… 
    616613 * \return NULL if cannot allocate memory or other error 
    617614 * \return pointer to structure, if no error 
    618  * \todo make typesafe 
    619615 */ 
    620616ops_text_t *ops_showall_ss_preferred_compression(ops_ss_preferred_compression_t ss_preferred_compression) 
    …… 
    630626 * returns description of the Hash Algorithm type 
    631627 * \param hash Hash Algorithm type 
    632  * \todo add reference 
    633  * \todo make typesafe 
    634628 * \return string or "Unknown" 
    635629 */ 
    …… 
    646640 * \return NULL if cannot allocate memory or other error 
    647641 * \return pointer to structure, if no error 
    648  * \todo make typesafe 
    649642 */ 
    650643ops_text_t *ops_showall_ss_preferred_hash(ops_ss_preferred_hash_t ss_preferred_hash) 
    …… 
    663656 * returns description of the given Preferred Symmetric Key Algorithm 
    664657 * \param octet 
    665  * \todo add reference 
    666658 * \return string or "Unknown" 
    667659*/ 
    …… 
    678670 * \return NULL if cannot allocate memory or other error 
    679671 * \return pointer to structure, if no error 
    680  * \todo make typesafe 
    681672 */ 
    682673ops_text_t *ops_showall_ss_preferred_ska(ops_ss_preferred_ska_t ss_preferred_ska) 
    …… 
    691682 * \param octet 
    692683 * \return string or "Unknown" 
    693  * \todo add reference 
    694684*/ 
    695685static char *ops_show_ss_feature(unsigned char octet,unsigned offset) 
    …… 
    707697 * \return NULL if cannot allocate memory or other error 
    708698 * \return pointer to structure, if no error 
    709  * \todo make typesafe 
    710  * \todo add reference 
    711699 */ 
    712700/* XXX: shouldn't this use show_all_octets_bits? */ 
    …… 
    750738 * \param map 
    751739 * \return 
    752  * \todo add reference 
    753740*/ 
    754741const char *ops_show_ss_key_flag(unsigned char octet, ops_bit_map_t *map) 
    …… 
    764751 * \return NULL if cannot allocate memory or other error 
    765752 * \return pointer to structure, if no error 
    766  * \todo make typesafe 
    767  * \todo add reference 
    768753 */ 
    769754ops_text_t *ops_showall_ss_key_flags(ops_ss_key_flags_t ss_key_flags) 
    …… 
    807792 * \param map 
    808793 * \return string or "Unknown" 
    809  * \todo add reference 
    810  * \todo make typesafe 
    811794 */ 
    812795const char *ops_show_ss_key_server_prefs(unsigned char prefs, 
    …… 
    822805 * \return NULL if cannot allocate memory or other error 
    823806 * \return pointer to structure, if no error 
    824  * \todo make typesafe 
    825  * \todo add reference 
    826807 *  
    827808*/ 
    …… 
    866847 * \return NULL if cannot allocate memory or other error 
    867848 * \return pointer to structure, if no error 
    868  * \todo make typesafe 
    869  * \todo add reference 
    870849 */ 
    871850ops_text_t *ops_showall_ss_notation_data_flags(ops_ss_notation_data_t ss_notation_data) 

  • openpgpsdk/trunk/src/lib/signature.c

    r630 r636  
    611611 * \param id The user ID being bound to the key 
    612612 * \param type Signature type 
    613  * \todo Expand description. Allow other hashes. 
    614613 */ 
    615614void ops_signature_start_key_signature(ops_create_signature_t *sig, 
    …… 
    743742 * \param info 
    744743 * 
    745  * \todo get a better description of how/when this is used 
    746744 */ 
    747745