root/openpgpsdk/trunk/src/doxygen.c

Revision 430 (checked in by rachel, 6 years ago)

fixed problems with initial doc config

Line 
1 /*! \mainpage Documentation
2  *
3  * The OpenPGP::SDK library has 2 APIs, which can be used interchangeably by a developer.
4
5 \section section_std_api The Standard API
6
7 The Standard API provides easy access to common crypto tasks.
8
9 Examples are:
10
11 - "find the key in the keyring corresponding to this id"
12 - "sign this text with that key".
13
14 It is built on functions offered by the Advanced API.
15
16 Developers should initially consider using the Standard API, unless they need the additional control available in the Advanced API.
17
18 - \ref StandardAPI : follow this link for more details
19
20 \section section_adv_api The Advanced API
21
22 The Advanced API offers detailed control over all aspects of the SDK.
23
24 - \ref AdvancedAPI : follow this link for more details
25
26 */
27
28 /** @defgroup StandardAPI Standard API
29 This API provides basic high-level functionality, which should be
30 suitable for most users.
31
32 If you want more fine-grained control, consider using the Advanced API.
33 */
34
35 /** @defgroup AdvancedAPI Advanced API
36 This API provides detailed control over all aspects of the SDK.
37
38 You may find that the easier-to-use Standard API meets your needs.
39 */
40
41 /**
42  * @defgroup Parse Parse
43  * \ingroup AdvancedAPI
44  * These functions allow an OpenPGP object (for example, an OpenPGP message or keyring) to be parsed.
45  *
46  * \par Usage 1 : To Parse an input stream (discarding parsed data)
47  * - Configure an ops_parse_options_t structure
48  *   - Set "Reader" function and args (to get the data)
49  *   - Set "Callback" function and args (to do something useful with the parsed data)
50  * - Call ops_parse_options() to specify whether individual subpacket types are to parsed, left raw or ignored
51  * - Finally, call ops_parse()
52  *
53  * \par Usage 2 : To Parse an input stream (storing parsed data in keyring)
54  * - Get keyring
55  * - Configure an ops_parse_options_t structure
56  *   - Set "Reader" function and args (to get the data)
57  *   - No need to set "Callback" function and args
58  * - No need to call ops_parse_options() to specify whether individual subpacket types are to parsed, left raw or ignored
59  * - Call ops_parse_and_accumulate() to populate keyring
60  * - Don't forget to call ops_keyring_free() when you've finished with the keyring to release the memory.
61  *
62  * \par Readers:
63  * - ops_reader_fd() is one reader function provided by this library to read from an open file.
64  * - Users may define their own readers.
65  *
66  */
67 /**
68  * @defgroup Create Create
69  * \ingroup AdvancedAPI
70  * These functions allow an OpenPGP object to be created.
71  *
72  * The low-level functions are provided to enable flexible usage.
73  * Higher-level functions which bundle several functions together into
74  * common operations may be added in the future.
75  *
76  * \par Example Usage 1 : To create an unsigned RSA public key with user id:
77  * - Get the key parameters (creation time, modulus, exponent)
78  * - Get the userid
79  * - Configure an ops_writer_fd_arg_t structure
80  *   - Set "Writer" function
81  * - Call ops_write_rsa_public_key()
82  * - Call ops_write_user_id()
83  *
84  * \par Writers:
85  * - ops_writer_fd() is one writer function provided by this library to write to an open file.
86  * - Users may define their own writers.
87  *
88  */
89 /**
90  * @defgroup Memory Memory
91  * \ingroup AdvancedAPI
92  * These functions relate to memory usage.
93  */
94 /**
95  * @defgroup Show Show
96  * \ingroup AdvancedAPI
97  * These functions allow the contents to be displayed in human-readable form.
98  */
99 /**
100  * @defgroup Utils Utils
101  * \ingroup AdvancedAPI
102  * These functions are of general utility.
103  */
104 /**
105  * @defgroup Verify Verify
106  * \ingroup AdvancedAPI
107  * These functions are for verifying signatures.
108  */
109
110 /**
111  * @defgroup Callbacks Callbacks
112  * \ingroup AdvancedAPI
113  * These callback functions are used when parsing or creating.
114  */
115
Note: See TracBrowser for help on using the browser.