summaryrefslogtreecommitdiff
path: root/Userland/Libraries/LibMarkdown/Document.h
diff options
context:
space:
mode:
Diffstat (limited to 'Userland/Libraries/LibMarkdown/Document.h')
-rw-r--r--Userland/Libraries/LibMarkdown/Document.h11
1 files changed, 11 insertions, 0 deletions
diff --git a/Userland/Libraries/LibMarkdown/Document.h b/Userland/Libraries/LibMarkdown/Document.h
index 796fdbda10..db3e0fc0d6 100644
--- a/Userland/Libraries/LibMarkdown/Document.h
+++ b/Userland/Libraries/LibMarkdown/Document.h
@@ -23,6 +23,17 @@ public:
String render_to_inline_html() const;
String render_for_terminal(size_t view_width = 0) const;
+ /*
+ * Walk recursively through the document tree. Returning `RecursionDecision::Recurse` from
+ * `Visitor::visit` proceeds with the next element of the pre-order walk, usually a child element.
+ * Returning `RecursionDecision::Continue` skips the subtree, and usually proceeds with the next
+ * sibling. Returning `RecursionDecision::Break` breaks the recursion, with no further calls to
+ * any of the `Visitor::visit` methods.
+ *
+ * Note that `walk()` will only return `RecursionDecision::Continue` or `RecursionDecision::Break`.
+ */
+ RecursionDecision walk(Visitor&) const;
+
static OwnPtr<Document> parse(const StringView&);
private: