Changeset 612

Show
Ignore:
Timestamp:
09/03/08 09:43:53
Author:
rachel
Message:

This (and previous commit) adds extra doxygen documentation.

Files:

Legend:

Unmodified
Added
Removed
Modified
Copied
Moved

  • openpgpsdk/trunk/Makefile

    r605 r612  
    4646        cd doc && $(MAKE) 
    4747 
    48 #cunit: 
    49 #       if [ ! -d CUnit-2.1-0 ]; then \ 
    50 #               gunzip CUnit-2.1-0-src.tar.gz; \ 
    51 #               tar xvf CUnit-2.1-0-src.tar; \ 
    52 #               (cd CUnit-2.1-0 && ./configure --prefix $(PWD) && make && make install); \ 
    53 #       fi 
    54  
    55  
    5648coverity:: 
    5749        cov-build --dir coverity make 

  • openpgpsdk/trunk/doc/doxygen-user.cfg

    r430 r612  
    448448 
    449449# XX - changed by weasel 
    450 INPUT                  = ../src ../src/standard ../include/openpgpsdk 
     450INPUT                  = ../src ../src/lib ../include/openpgpsdk 
    451451 
    452452# If the value of the INPUT tag contains directories, you can use the  
    …… 
    463463# If left blank NO is used. 
    464464 
    465 RECURSIVE              = YES 
     465RECURSIVE              = NO 
    466466 
    467467# The EXCLUDE tag can be used to specify files and/or directories that should  
    …… 
    487487# the \include command). 
    488488 
    489 EXAMPLE_PATH           =  
     489EXAMPLE_PATH           = ../src/examples 
    490490 
    491491# If the value of the EXAMPLE_PATH tag contains directories, you can use the  

  • openpgpsdk/trunk/include/openpgpsdk/keyring.h

    r570 r612  
    5353const ops_public_key_t * 
    5454ops_get_public_key_from_data(const ops_keydata_t *data); 
    55 ops_boolean_t ops_key_is_secret(const ops_keydata_t *data); 
     55ops_boolean_t ops_is_key_secret(const ops_keydata_t *data); 
    5656const ops_secret_key_t * 
    5757ops_get_secret_key_from_data(const ops_keydata_t *data); 
    …… 
    6262 
    6363ops_boolean_t ops_keyring_read_from_file(ops_keyring_t *keyring, const ops_boolean_t armour, const char *filename); 
    64 ops_boolean_t ops_keyring_read_from_mem(ops_keyring_t *keyring, ops_memory_t *mem); 
     64ops_boolean_t ops_keyring_read_from_mem(ops_keyring_t *keyring, const ops_boolean_t armour, ops_memory_t *mem); 
    6565 
    6666char *ops_malloc_passphrase(char *passphrase); 
    6767char *ops_get_passphrase(void); 
    6868 
    69 void ops_keyring_list(const ops_keyring_t* keyring, const char* match); 
     69void ops_keyring_list(const ops_keyring_t* keyring); 
    7070 
    7171void ops_set_secret_key(ops_parser_content_union_t* content,const ops_keydata_t *key); 
    …… 
    7474unsigned ops_get_user_id_count(const ops_keydata_t *key); 
    7575const unsigned char* ops_get_user_id(const ops_keydata_t *key, unsigned index); 
    76 ops_boolean_t ops_key_is_supported(const ops_keydata_t *key); 
    77 const ops_keydata_t* ops_keyring_get_key(const ops_keyring_t *keyring, int index); 
     76ops_boolean_t ops_is_key_supported(const ops_keydata_t *key); 
     77const ops_keydata_t* ops_keyring_get_key_by_index(const ops_keyring_t *keyring, int index); 
    7878 
    7979ops_user_id_t* ops_add_userid_to_keydata(ops_keydata_t* keydata, const ops_user_id_t* userid); 

  • openpgpsdk/trunk/src/app/openpgp.c

    r583 r612  
    342342            } 
    343343         
    344         ops_keyring_list(myring,(char *)NULL); 
     344        ops_keyring_list(myring); 
    345345        //        ops_keyring_free(&kering); 
    346346        break; 
    …… 
    406406            } 
    407407        fprintf(stderr,"before:\n"); 
    408         ops_keyring_list(myring,NULL); 
     408        ops_keyring_list(myring); 
    409409 
    410410        // read new key 
    …… 
    416416 
    417417        fprintf(stderr,"after:\n"); 
    418         ops_keyring_list(myring,NULL); 
     418        ops_keyring_list(myring); 
    419419         
    420420        break; 
    …… 
    427427            } 
    428428         
    429         //        mykeydata=ops_keydata_new(); 
    430         //        if (ops_rsa_generate_keypair(1024,65537,mykeydata)!=ops_true) 
    431429        uid.user_id=(unsigned char *)opt_userid; 
    432430        mykeydata=ops_rsa_create_selfsigned_keypair(numbits,65537,&uid); 
    …… 
    453451        ops_write_transferable_secret_key(mykeydata, NULL, 0, ops_false, cinfo); 
    454452        ops_teardown_file_write(cinfo,fd); 
    455         ops_keyring_free(pubring); 
     453        ops_keyring_free(secring); 
    456454        if (!ops_keyring_read_from_file(secring,ops_false,secring_name)) 
    457455            { 
    …… 
    490488        overwrite=ops_true; 
    491489        ops_encrypt_file(opt_filename, outputfilename, keydata, armour,overwrite); 
    492         //ops_keyring_free(&keyring); 
    493490        break; 
    494491 
    …… 
    502499        overwrite=ops_true; 
    503500        ops_decrypt_file(opt_filename, NULL, secring, armour,overwrite,callback_cmd_get_passphrase_from_cmdline); 
    504         //ops_keyring_free(&keyring); 
    505501        break; 
    506502 

  • openpgpsdk/trunk/src/doxygen.c

    r430 r612  
    33 * The OpenPGP::SDK library has 2 APIs, which can be used interchangeably by a developer. 
    44 
    5 \section section_std_api The Standard API 
     5\section section_highlevel_api The High-Level API 
    66 
    7 The Standard API provides easy access to common crypto tasks.  
     7The High-Level API provides easy access to common crypto tasks.  
    88 
    99Examples are: 
    …… 
    1212- "sign this text with that key". 
    1313 
    14 It is built on functions offered by the Advanced API. 
     14It is built on functions offered by the Core API. 
    1515 
    16 Developers should initially consider using the Standard API, unless they need the additional control available in the Advanced API. 
     16Developers should initially consider using the High-Level API, unless they need the additional control available in the Core API. 
    1717 
    18 - \ref StandardAPI : follow this link for more details 
     18- \ref HighLevelAPI : follow this link for more details 
    1919 
    20 \section section_adv_api The Advanced API 
     20\section section_core_api The Core API 
    2121 
    22 The Advanced API offers detailed control over all aspects of the SDK. 
     22The Core API offers detailed control over all aspects of the SDK. 
    2323 
    24 - \ref AdvancedAPI : follow this link for more details 
     24- \ref CoreAPI : follow this link for more details 
    2525 
    2626*/ 
    2727 
    28 /** @defgroup StandardAPI Standard API 
    29 This API provides basic high-level functionality, which should be 
    30 suitable for most users. 
     28/** @defgroup HighLevelAPI High Level API 
     29\brief This API provides basic high-level functionality, which should be 
     30suitable for most users.  
    3131 
    32 If you want more fine-grained control, consider using the Advanced API. 
     32If you want more fine-grained control, consider using the Core API. 
     33 
     34Expected modules: 
     35encrypt, decrypt, sign, verify, keys, print 
    3336*/ 
    3437 
    35 /** @defgroup AdvancedAPI Advanced API 
     38/** @defgroup CoreAPI Core API 
    3639This API provides detailed control over all aspects of the SDK. 
    3740 
    38 You may find that the easier-to-use Standard API meets your needs. 
     41You may find that the easier-to-use High Level API meets your needs. 
    3942*/ 
     43 
     44/** \defgroup HighLevel_Misc Miscellaneous 
     45    \ingroup HighLevelAPI 
     46 */ 
     47     
     48/** 
     49    \defgroup HighLevel_Keyring Keyring 
     50    \ingroup HighLevelAPI 
     51*/ 
     52 
     53/** 
     54    \defgroup HighLevel_KeyringRead Read Keyring 
     55    \ingroup HighLevel_Keyring 
     56*/ 
     57 
     58/** 
     59    \defgroup HighLevel_KeyringList List Keyring 
     60    \ingroup HighLevel_Keyring 
     61*/ 
     62 
     63/** 
     64    \defgroup HighLevel_KeyringFind Find Key 
     65    \ingroup HighLevel_Keyring 
     66*/ 
     67 
     68/** 
     69    \defgroup HighLevel_KeyringMemory Memory Ops 
     70    \ingroup HighLevel_Keyring 
     71*/ 
     72 
     73/** 
     74    \defgroup HighLevel_Key Key 
     75    \ingroup HighLevel_Keyring 
     76*/ 
     77 
     78/** 
     79   \defgroup HighLevel_Parse Parse 
     80   \ingroup HighLevelAPI 
     81*/ 
     82 
     83/** 
     84   \defgroup HighLevel_Readers Readers 
     85*/ 
     86 
     87/** 
     88   \defgroup HighLevel_Writers Writers 
     89*/ 
     90 
     91/** 
     92   \defgroup Core_Callbacks Callbacks 
     93   \ingroup CoreAPI 
     94*/ 
     95 
     96/* 
     97   \defgroup Create 
     98   \ingroup CoreAPI 
     99*/ 
     100 
     101/*  
     102 */ 
    40103 
    41104/**