From 5a8784817cc0ff505a502d20e6eb6975ef281d15 Mon Sep 17 00:00:00 2001
From: John Mark Bell <jmb@netsurf-browser.org>
Date: Thu, 8 Jan 2009 19:38:36 +0000
Subject: Use doxygen to create API documentation. Add a bunch of extra
 commentary to stop doxygen warning.

svn path=/trunk/hubbub/; revision=5994
---
 include/hubbub/parser.h | 12 ++++++------
 include/hubbub/tree.h   | 36 ++++++++++++++++++------------------
 include/hubbub/types.h  |  4 ++--
 3 files changed, 26 insertions(+), 26 deletions(-)

(limited to 'include')

diff --git a/include/hubbub/parser.h b/include/hubbub/parser.h
index d08d70e..803ec21 100644
--- a/include/hubbub/parser.h
+++ b/include/hubbub/parser.h
@@ -37,22 +37,22 @@ typedef union hubbub_parser_optparams {
 	struct {
 		hubbub_token_handler handler;
 		void *pw;
-	} token_handler;
+	} token_handler;		/**< Token handling callback */
 
 	struct {
 		hubbub_error_handler handler;
 		void *pw;
-	} error_handler;
+	} error_handler;		/**< Error handling callback */
 
 	struct {
 		hubbub_content_model model;
-	} content_model;
+	} content_model;		/**< Current content model */
 
-	hubbub_tree_handler *tree_handler;
+	hubbub_tree_handler *tree_handler;	/**< Tree handling callbacks */
 
-	void *document_node;
+	void *document_node;		/**< Document node */
 
-	bool enable_scripting;
+	bool enable_scripting;		/**< Whether to enable scripting */
 } hubbub_parser_optparams;
 
 /* Create a hubbub parser */
diff --git a/include/hubbub/tree.h b/include/hubbub/tree.h
index 0a286a0..55501e0 100644
--- a/include/hubbub/tree.h
+++ b/include/hubbub/tree.h
@@ -14,24 +14,24 @@
  * Hubbub tree handler
  */
 typedef struct hubbub_tree_handler {
-	hubbub_tree_create_comment create_comment;
-	hubbub_tree_create_doctype create_doctype;
-	hubbub_tree_create_element create_element;
-	hubbub_tree_create_text create_text;
-	hubbub_tree_ref_node ref_node;
-	hubbub_tree_unref_node unref_node;
-	hubbub_tree_append_child append_child;
-	hubbub_tree_insert_before insert_before;
-	hubbub_tree_remove_child remove_child;
-	hubbub_tree_clone_node clone_node;
-	hubbub_tree_reparent_children reparent_children;
-	hubbub_tree_get_parent get_parent;
-	hubbub_tree_has_children has_children;
-	hubbub_tree_form_associate form_associate;
-	hubbub_tree_add_attributes add_attributes;
-	hubbub_tree_set_quirks_mode set_quirks_mode;
-	hubbub_tree_encoding_change encoding_change;
-	void *ctx;
+	hubbub_tree_create_comment create_comment;	/**< Create comment */
+	hubbub_tree_create_doctype create_doctype;	/**< Create doctype */
+	hubbub_tree_create_element create_element;	/**< Create element */
+	hubbub_tree_create_text create_text;		/**< Create text */
+	hubbub_tree_ref_node ref_node;			/**< Reference node */
+	hubbub_tree_unref_node unref_node;		/**< Unreference node */
+	hubbub_tree_append_child append_child;		/**< Append child */
+	hubbub_tree_insert_before insert_before;	/**< Insert before */
+	hubbub_tree_remove_child remove_child;		/**< Remove child */
+	hubbub_tree_clone_node clone_node;		/**< Clone node */
+	hubbub_tree_reparent_children reparent_children;/**< Reparent children*/
+	hubbub_tree_get_parent get_parent;		/**< Get parent */
+	hubbub_tree_has_children has_children;		/**< Has children? */
+	hubbub_tree_form_associate form_associate;	/**< Form associate */
+	hubbub_tree_add_attributes add_attributes;	/**< Add attributes */
+	hubbub_tree_set_quirks_mode set_quirks_mode;	/**< Set quirks mode */
+	hubbub_tree_encoding_change encoding_change;	/**< Change encoding */
+	void *ctx;					/**< Context pointer */
 } hubbub_tree_handler;
 
 #endif
diff --git a/include/hubbub/types.h b/include/hubbub/types.h
index 07ef2ab..b2f3670 100644
--- a/include/hubbub/types.h
+++ b/include/hubbub/types.h
@@ -112,7 +112,7 @@ typedef struct hubbub_tag {
  * Token data
  */
 typedef struct hubbub_token {
-	hubbub_token_type type;
+	hubbub_token_type type;		/**< The token type */
 
 	union {
 		hubbub_doctype doctype;
@@ -122,7 +122,7 @@ typedef struct hubbub_token {
 		hubbub_string comment;
 
 		hubbub_string character;
-	} data;
+	} data;				/**< Type-specific data */
 } hubbub_token;
 
 #endif
-- 
cgit v1.2.3