Add lots of new code comments.

darcs-hash:20080113164747-75c98-9d0cefd27be7aef7ba60772616d9da7e6bb52912.gz

1 files changed, 19 insertions, 0 deletions

diff --git a/function.h b/function.h
index c4e9030e..a79b3725 100644
--- a/function.h
+++ b/function.h
@@ -19,11 +19,30 @@
 */
 typedef struct function_data
 {
+	/**
+	   Name of function
+	 */
 	wchar_t *name;
+	/**
+	   Description of function
+	 */
 	wchar_t *description;
+	/**
+	   Function definition
+	 */
 	wchar_t *definition;
+	/**
+	   List of all event handlers for this function
+	 */
 	array_list_t *events;
+	/**
+	   List of all named arguments for this function
+	 */
 	array_list_t *named_arguments;
+	/**
+	   Set to non-zero if invoking this function shadows the variables
+	   of the underlying function.
+	 */
 	int shadows;
 }
 	function_data_t;