aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--src/doctree.hh9
-rw-r--r--src/styleengine.hh9
2 files changed, 18 insertions, 0 deletions
diff --git a/src/doctree.hh b/src/doctree.hh
index f74350b0..53ae76e0 100644
--- a/src/doctree.hh
+++ b/src/doctree.hh
@@ -11,6 +11,15 @@ class DoctreeNode {
const char *id;
};
+/**
+ * \brief HTML document tree interface.
+ *
+ * The Doctree class defines the interface to the parsed HTML document tree
+ * as it is used for CSS selector matching.
+ * Currently the Doctree can be represented as stack, however to support
+ * CSS adjacent siblings or for future JavaScript support it may have to
+ * be extended to a real tree.
+ */
class Doctree {
public:
virtual ~Doctree () {};
diff --git a/src/styleengine.hh b/src/styleengine.hh
index f340e058..5d5f7c18 100644
--- a/src/styleengine.hh
+++ b/src/styleengine.hh
@@ -8,6 +8,15 @@ class StyleEngine;
#include "css.hh"
#include "cssparser.hh"
+/**
+ * \brief This class provides the glue between HTML parser and CSS subsystem.
+ *
+ * It maintains a document tree and creates and cashes style objects for use
+ * by the HTML parser.
+ * The HTML parser in turn informs StyleEngine about opened or closed
+ * HTML elements and their attributes via the startElement() / endElement()
+ * methods.
+ */
class StyleEngine : public Doctree {
private:
class Node : public DoctreeNode {