summaryrefslogtreecommitdiff
path: root/src/treebuilder
diff options
context:
space:
mode:
authorJohn Mark Bell <jmb@netsurf-browser.org>2009-01-08 19:38:36 +0000
committerJohn Mark Bell <jmb@netsurf-browser.org>2009-01-08 19:38:36 +0000
commit5a8784817cc0ff505a502d20e6eb6975ef281d15 (patch)
tree899dff475bfc40c3dcc72bf4808a0859752a8dbe /src/treebuilder
parent024709d09ec4dbf301588258360fa9891c17000e (diff)
downloadlibhubbub-5a8784817cc0ff505a502d20e6eb6975ef281d15.tar.gz
libhubbub-5a8784817cc0ff505a502d20e6eb6975ef281d15.tar.bz2
Use doxygen to create API documentation.
Add a bunch of extra commentary to stop doxygen warning. svn path=/trunk/hubbub/; revision=5994
Diffstat (limited to 'src/treebuilder')
-rw-r--r--src/treebuilder/in_body.c7
-rw-r--r--src/treebuilder/in_foreign_content.c9
-rw-r--r--src/treebuilder/internal.h20
-rw-r--r--src/treebuilder/treebuilder.h8
4 files changed, 31 insertions, 13 deletions
diff --git a/src/treebuilder/in_body.c b/src/treebuilder/in_body.c
index f9fbfe7..8de663b 100644
--- a/src/treebuilder/in_body.c
+++ b/src/treebuilder/in_body.c
@@ -15,9 +15,12 @@
#undef DEBUG_IN_BODY
+/**
+ * Bookmark for formatting list. Used in adoption agency
+ */
typedef struct bookmark {
- formatting_list_entry *prev;
- formatting_list_entry *next;
+ formatting_list_entry *prev; /**< Previous entry */
+ formatting_list_entry *next; /**< Next entry */
} bookmark;
static void process_character(hubbub_treebuilder *treebuilder,
diff --git a/src/treebuilder/in_foreign_content.c b/src/treebuilder/in_foreign_content.c
index 8cb17d8..9b09752 100644
--- a/src/treebuilder/in_foreign_content.c
+++ b/src/treebuilder/in_foreign_content.c
@@ -19,11 +19,14 @@
#define S(s) s, SLEN(s)
+/**
+ * Mapping table for case changes
+ */
typedef struct
{
- const char *attr;
- size_t len;
- const char *proper;
+ const char *attr; /**< Lower case attribute name */
+ size_t len; /**< Length of name in bytes */
+ const char *proper; /**< Correctly cased version */
} case_changes;
static const case_changes svg_attributes[] = {
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 */
diff --git a/src/treebuilder/treebuilder.h b/src/treebuilder/treebuilder.h
index 0f883ec..ba5db1a 100644
--- a/src/treebuilder/treebuilder.h
+++ b/src/treebuilder/treebuilder.h
@@ -37,13 +37,13 @@ typedef union hubbub_treebuilder_optparams {
struct {
hubbub_error_handler handler;
void *pw;
- } error_handler;
+ } error_handler; /**< Error handling callback */
- hubbub_tree_handler *tree_handler;
+ hubbub_tree_handler *tree_handler; /**< Tree handling callbacks */
- void *document_node;
+ void *document_node; /**< The document node */
- bool enable_scripting;
+ bool enable_scripting; /**< Enable scripting */
} hubbub_treebuilder_optparams;
/* Create a hubbub treebuilder */