more updates

[udis86.git] / tests / example.c

diff --git a/tests/example.c b/tests/example.c
index 73ab29622e2cc4f8d612e46ea95b2b5e4d896e9e..00c9b8beaf0db360ec9002236d7c1598d1b901fc 100644 (file)
--- a/tests/example.c
+++ b/tests/example.c
@@ -1,4 +1,17 @@
-
+/*! \file tests/example.c
+ *
+ * \page Example Quick usage example
+ *
+ * The following code is an example of a program that interfaces 
+ * with libudis86 and uses the API to generate assembly language 
+ * output for 64-bit code, input from STDIN.
+ *
+ * \include tests/example.c
+ *
+ * To compile the program (using gcc):
+ * 
+ * \code $ gcc -ludis86 example.c -o example \endcode
+ */
 #include <stdio.h>
 #include <udis86.h>