From 5a8784817cc0ff505a502d20e6eb6975ef281d15 Mon Sep 17 00:00:00 2001 From: John Mark Bell 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 --- src/treebuilder/internal.h | 20 ++++++++++++++++---- 1 file changed, 16 insertions(+), 4 deletions(-) (limited to 'src/treebuilder/internal.h') diff --git a/src/treebuilder/internal.h b/src/treebuilder/internal.h index 6e5d80f..0649f25 100644 --- a/src/treebuilder/internal.h +++ b/src/treebuilder/internal.h @@ -36,6 +36,9 @@ typedef enum UNKNOWN, } element_type; +/** + * Item on the element stack + */ typedef struct element_context { hubbub_ns ns; /**< Element namespace */ @@ -51,6 +54,9 @@ typedef struct element_context void *node; /**< Node pointer */ } element_context; +/** + * Entry in a formatting list + */ typedef struct formatting_list_entry { element_context details; /**< Entry details */ @@ -61,6 +67,9 @@ typedef struct formatting_list_entry struct formatting_list_entry *next; /**< Next in list */ } formatting_list_entry; +/** + * Context for a tree builder + */ typedef struct hubbub_treebuilder_context { insertion_mode mode; /**< The current insertion mode */ @@ -100,16 +109,19 @@ typedef struct hubbub_treebuilder_context * be foster parented */ } hubbub_treebuilder_context; +/** + * Treebuilder object + */ struct hubbub_treebuilder { hubbub_tokeniser *tokeniser; /**< Underlying tokeniser */ - hubbub_treebuilder_context context; + hubbub_treebuilder_context context; /**< Our context */ - hubbub_tree_handler *tree_handler; + hubbub_tree_handler *tree_handler; /**< Callback table */ - hubbub_error_handler error_handler; - void *error_pw; + hubbub_error_handler error_handler; /**< Error handler */ + void *error_pw; /**< Error handler data */ hubbub_alloc alloc; /**< Memory (de)allocation function */ void *alloc_pw; /**< Client private data */ -- cgit v1.2.3