1 /****h* silcexample/SilcExampleAPI
2 *
3 * DESCRIPTION
4 *
5 * This is example API providing the examples of how API items may appear
6 * in the Toolkit Reference Manual. This example includes all aspects of
7 * a reference, however, note that all API items that appear in the manual
8 * may not include all of the information that are presented here.
9 *
10 ***/
11
12 /****d* silcexample/SilcExampleAPI/SilcExampleType
13 *
14 * NAME
15 *
16 * typedef enum { ... } SilcExampleTyle;
17 *
18 * DESCRIPTION
19 *
20 * Example type definition with the actual source code.
21 *
22 * SOURCE
23 */
24 /* Source code from the actual header file is appended */
25 typedef enum {
26 SILC_EXAMPLE_1,
27 SILC_EXAMPLE_2,
28 SILC_EXAMPLE_3,
29 } SilcExampleType;
30 /***/
31
32 /****s* silcexample/SilcExampleAPI/SilcExampleStruct
33 *
34 * NAME
35 *
36 * typedef struct { ... } SilcExampleStruct;
37 *
38 * DESCRIPTION
39 *
40 * Example structure definition.
41 *
42 ***/
43
44 /****f* silcexample/SilcExampleAPI/silc_example_function
45 *
46 * SYNOPSIS
47 *
48 * bool silc_example_function(SilcExampleType type);
49 *
50 * DESCRIPTION
51 *
52 * Description of the silc_example_function.
53 *
54 * NOTES
55 *
56 * There may be additional notes that programmers should be aware of
57 * for this function.
58 *
59 * EXAMPLE
60 *
61 * if (!silc_example_function(SILC_EXAMPLE_1))
62 * SILC_LOG_ERROR(("Error occurred during example function"));
63 *
64 * SEE ALSO
65 *
66 * SilcExampleType, SILC_LOG_ERROR, SilcExampleStruct
67 *
68 ***/
69
This page was automatically generated by the LXR engine.
Free-text search provided by Glimpse