From: Pekka Riikonen <priikone@silcnet.org>
Date: Tue, 12 Feb 2002 13:11:20 +0000 (+0000)
Subject: 	updates
X-Git-Tag: silc.client.0.8.1~77
X-Git-Url: http://git.silcnet.org/gitweb/?p=silc.git;a=commitdiff_plain;h=5ef1b70f914e10cdf2f336e243cf41b6d2b808ae

	updates
---

diff --git a/lib/doc/intro_reference.html b/lib/doc/intro_reference.html
index 391cc1c4..bb78cd47 100644
--- a/lib/doc/intro_reference.html
+++ b/lib/doc/intro_reference.html
@@ -120,4 +120,12 @@ the header file where the documentation was automatically generated.
 
 <br />&nbsp;<br />
 Note that some of these informations are optional and not all API items
-include all of these informations.
\ No newline at end of file
+include all of these informations.
+
+<br />&nbsp;<br />&nbsp;<br />
+<b>Reference Example</b>
+
+<br />&nbsp;<br />
+Please refer to this link for short example of the API item reference 
+layout: <a href="silc_example.html">SILC Example API</a>.
+
diff --git a/lib/doc/silc_example.h b/lib/doc/silc_example.h
new file mode 100644
index 00000000..38a11780
--- /dev/null
+++ b/lib/doc/silc_example.h
@@ -0,0 +1,68 @@
+/****h* silcexample/SilcExampleAPI
+ *
+ * DESCRIPTION
+ *
+ * This is example API providing the examples of how API items may appear
+ * in the Toolkit Reference Manual.  This example includes all aspects of
+ * a reference, however, note that all API items that appear in the manual
+ * may not include all of the information that are presented here.
+ *
+ ***/
+
+/****d* silcexample/SilcExampleAPI/SilcExampleType
+ *
+ * NAME
+ *
+ *    typedef enum { ... } SilcExampleTyle;
+ *
+ * DESCRIPTION
+ *
+ *    Example type definition with the actual source code.
+ *
+ * SOURCE
+ */
+/* Source code from the actual header file is appended */
+typedef enum {
+  SILC_EXAMPLE_1,
+  SILC_EXAMPLE_2,
+  SILC_EXAMPLE_3,
+} SilcExampleType;
+/***/
+
+/****s* silcexample/SilcExampleAPI/SilcExampleStruct
+ *
+ * NAME
+ *
+ *    typedef struct { ... } SilcExampleStruct;
+ *
+ * DESCRIPTION
+ *
+ *    Example structure definition.
+ *
+ ***/
+
+/****f* silcexample/SilcExampleAPI/silc_example_function
+ *
+ * SYNOPSIS
+ *
+ *    bool silc_example_function(SilcExampleType type);
+ *
+ * DESCRIPTION
+ *
+ *    Description of the silc_example_function.
+ *
+ * NOTES
+ *
+ *    There may be additional notes that programmers should be aware of
+ *    for this function.
+ *
+ * EXAMPLE
+ *
+ *    if (!silc_example_function(SILC_EXAMPLE_1))
+ *      SILC_LOG_ERROR(("Error occurred during example function"));
+ *
+ * SEE ALSO
+ *
+ *    SilcExampleType, SILC_LOG_ERROR, SilcExampleStruct
+ *
+ ***/