1 /****h* silcexample/SilcExampleAPI
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.
12 /****d* silcexample/SilcExampleAPI/SilcExampleType
16 * typedef enum { ... } SilcExampleTyle;
20 * Example type definition with the actual source code.
24 /* Source code from the actual header file is appended */
32 /****s* silcexample/SilcExampleAPI/SilcExampleStruct
36 * typedef struct { ... } SilcExampleStruct;
40 * Example structure definition.
44 /****f* silcexample/SilcExampleAPI/silc_example_function
48 * bool silc_example_function(SilcExampleType type);
52 * Description of the silc_example_function.
56 * There may be additional notes that programmers should be aware of
61 * if (!silc_example_function(SILC_EXAMPLE_1))
62 * SILC_LOG_ERROR(("Error occurred during example function"));
66 * SilcExampleType, SILC_LOG_ERROR, SilcExampleStruct