Changeset 429

Show
Ignore:
Timestamp:
12/04/06 12:59:47
Author:
rachel
Message:

Remove references to redundant Public/Private API

Files:

Legend:

Unmodified
Added
Removed
Modified
Copied
Moved

  • openpgpsdk/trunk/src/doxygen.c

    r426 r429  
    2222- \ref AdvancedAPI : follow this link for more details 
    2323 
    24 \section section_examples Examples 
    25  
    26 The <code>examples</code> directory included in the distribution provides 
    27 various standalone applications which demonstrate usage of the library. 
    28  
    29 - \subpage page_examples : follow this link for more details 
    30  
    31 \section section_installation Installation 
    32  
    33 - \subpage page_installation : follow this link for installation instructions 
    34  
    35 \page page_examples Examples 
    36  
    37 TBD 
    38  
    39 \page page_installation Installation 
    40  
    41 TBD 
     24*/ 
    4225 
    4326/** @defgroup StandardAPI Standard API 
    …… 
    4831*/ 
    4932 
    50 /** @defgroup PublicAPI Public API 
    51  * These functions are public and available for external use. 
    52  * @{ 
    53  */ 
     33/** @defgroup AdvancedAPI Advanced API 
     34This API provides detailed control over all aspects of the SDK. 
     35 
     36You may find that the easier-to-use Standard API meets your needs. 
     37*/ 
     38 
    5439/** 
    5540 * @defgroup Parse Parse 
     41 * \ingroup AdvancedAPI 
    5642 * These functions allow an OpenPGP object (for example, an OpenPGP message or keyring) to be parsed. 
    5743 * 
    …… 
    7662 * - Users may define their own readers. 
    7763 * 
    78  * @ingroup PublicAPI 
    7964 */ 
    8065/** 
    8166 * @defgroup Create Create 
     67 * \ingroup AdvancedAPI 
    8268 * These functions allow an OpenPGP object to be created.  
    8369 * 
    …… 
    9884 * - Users may define their own writers. 
    9985 * 
    100  * @ingroup PublicAPI 
    10186 */ 
    10287/** 
    10388 * @defgroup Memory Memory 
     89 * \ingroup AdvancedAPI 
    10490 * These functions relate to memory usage. 
    105  * @ingroup PublicAPI 
    10691 */ 
    10792/** 
    10893 * @defgroup Show Show 
     94 * \ingroup AdvancedAPI 
    10995 * These functions allow the contents to be displayed in human-readable form. 
    110  * @ingroup PublicAPI 
    11196 */ 
    11297/** 
    11398 * @defgroup Utils Utils 
     99 * \ingroup AdvancedAPI 
    114100 * These functions are of general utility. 
    115  * @ingroup PublicAPI 
    116101 */ 
    117102/** 
    118103 * @defgroup Verify Verify 
     104 * \ingroup AdvancedAPI 
    119105 * These functions are for verifying signatures. 
    120  * @ingroup PublicAPI 
    121  */ 
    122 /** 
    123  * @} 
    124106 */ 
    125107 
    126 /** @defgroup PublicInternal Public-Internal API 
    127  * These functions are public but should not normally be called. 
    128  * @{ 
    129  */ 
    130108/** 
    131  * @defgroup IntCreate Create 
    132  * Used in Create functions 
    133  * 
    134  * @ingroup PublicInternal 
    135  */ 
    136 /** 
    137  * @} 
     109 * @defgroup Callbacks Callbacks 
     110 * \ingroup AdvancedAPI 
     111 * These callback functions are used when parsing or creating. 
    138112 */ 
    139113 
    140 /** @defgroup Internal Internal API 
    141  * These functions are static. 
    142  * @{ 
    143  */ 
    144 /** 
    145  * @defgroup Callbacks Callbacks 
    146  * These callback functions are used when parsing or creating. 
    147  * @ingroup Internal 
    148  */ 
    149 /** 
    150  * @} 
    151  */ 
    152